Cloudflare.GatewayProxyEndpoint (Cloudflare v0.5.0)

Copy Markdown View Source

Zero Trust Gateway proxy endpoints

Create a proxy endpoint

POST /accounts/{account_id}/gateway/proxy_endpoints

Create a new Zero Trust Gateway proxy endpoint.

Responses

200 Returns a created proxy endpoint response.

Data is at body["result"]

null
4XX Returns a created proxy endpoint response failure.
{
  "errors": {},
  "messages": {},
  "result": {},
  "success": "*boolean*"
}

List proxy endpoints

GET /accounts/{account_id}/gateway/proxy_endpoints

List all Zero Trust Gateway proxy endpoints for an account.

Responses

200 Returns a list of proxy endpoints response.

Data is at body["result"]

[
  null
]
4XX Returns a list of proxy endpoints response failure.
{
  "errors": {},
  "messages": {},
  "result": {},
  "result_info": {
    "count": "*number*",
    "page": "*number*",
    "per_page": "*number*",
    "total_count": "*number*"
  },
  "success": "*boolean*"
}

Update a proxy endpoint

PATCH /accounts/{account_id}/gateway/proxy_endpoints/{proxy_endpoint_id}

Update a configured Zero Trust Gateway proxy endpoint.

Responses

200 Returns an updated proxy endpoint response.

Data is at body["result"]

null
4XX Returns an updated proxy endpoint response failure.
{
  "errors": {},
  "messages": {},
  "result": {},
  "success": "*boolean*"
}

Get a proxy endpoint

GET /accounts/{account_id}/gateway/proxy_endpoints/{proxy_endpoint_id}

Get a single Zero Trust Gateway proxy endpoint.

Responses

200 Returns a proxy endpoint response.

Data is at body["result"]

null
4XX Returns a proxy endpoint response failure.
{
  "errors": {},
  "messages": {},
  "result": {},
  "success": "*boolean*"
}

Delete a proxy endpoint

DELETE /accounts/{account_id}/gateway/proxy_endpoints/{proxy_endpoint_id}

Delete a configured Zero Trust Gateway proxy endpoint.

Responses

200 Returns a deleted proxy endpoint response.

Data is at body["result"]

{}
4XX Returns a deleted proxy endpoint response failure.
{
  "errors": {},
  "messages": {},
  "result": {},
  "success": "*boolean*"
}

Summary

Functions

client(opts \\ [])
create(body, opts \\ [])
create!(body, opts \\ [])
delete(id, opts \\ [])
delete!(id, opts \\ [])
index(opts \\ [])
index!(opts \\ [])
path_for(id, opts \\ [])
show(id, opts \\ [])
show!(id, opts \\ [])
update(endpoint_id, body, opts \\ [])

Updates a Gateway proxy endpoint (PATCH).

Functions

client(opts \\ [])

@spec client(Restlax.Resource.action_options()) :: module()

create(body, opts \\ [])

@spec create(
  body :: Restlax.Resource.action_body(),
  opts :: Restlax.Resource.action_options()
) ::
  {:ok, map()} | {:error, term()}

create!(body, opts \\ [])

@spec create!(
  body :: Restlax.Resource.action_body(),
  opts :: Restlax.Resource.action_options()
) ::
  map() | no_return()

delete(id, opts \\ [])

@spec delete(id :: term(), opts :: Restlax.Resource.action_options()) ::
  {:ok, map()} | {:error, term()}

delete!(id, opts \\ [])

@spec delete!(id :: term(), opts :: Restlax.Resource.action_options()) ::
  map() | no_return()

index(opts \\ [])

@spec index(opts :: Restlax.Resource.action_options()) ::
  {:ok, map()} | {:error, term()}

index!(opts \\ [])

@spec index!(opts :: Restlax.Resource.action_options()) :: map() | no_return()

path_for(id, opts \\ [])

@spec path_for(term(), [{:action, String.t()}]) :: String.t()

show(id, opts \\ [])

@spec show(id :: term(), opts :: Restlax.Resource.action_options()) ::
  {:ok, map()} | {:error, term()}

show!(id, opts \\ [])

@spec show!(id :: term(), opts :: Restlax.Resource.action_options()) ::
  map() | no_return()

update(endpoint_id, body, opts \\ [])

Updates a Gateway proxy endpoint (PATCH).