Cloudflare.ZeroTrustGatewayLocation (Cloudflare v0.5.0)

Zero Trust Gateway locations

Create a Zero Trust Gateway location

POST /accounts/{account_id}/gateway/locations

Create a new Zero Trust Gateway location.

Responses

200 Creates a Zero Trust Gateway location response.

Data is at body["result"]

{
  "client_default": "*boolean*",
  "created_at": "*string*",
  "dns_destination_ips_id": "*string*",
  "dns_destination_ipv6_block_id": "*string*",
  "doh_subdomain": "*string*",
  "ecs_support": "*boolean*",
  "endpoints": {
    "doh": {
      "enabled": "*boolean*",
      "networks": null,
      "require_token": "*boolean*"
    },
    "dot": {
      "enabled": "*boolean*",
      "networks": null
    },
    "ipv4": {
      "enabled": "*boolean*"
    },
    "ipv6": {
      "enabled": "*boolean*",
      "networks": null
    }
  },
  "id": "*string*",
  "ip": "*string*",
  "ipv4_destination": "*string*",
  "ipv4_destination_backup": "*string*",
  "name": "*string*",
  "networks": [
    {
      "network": "*string*"
    }
  ],
  "updated_at": "*string*"
}

4XX Creates a Zero Trust Gateway location response failure.

{
  "errors": {},
  "messages": {},
  "result": {},
  "success": "*boolean*"
}

List Zero Trust Gateway locations

GET /accounts/{account_id}/gateway/locations

List Zero Trust Gateway locations for an account.

Responses

200 Lists Zero Trust Gateway locations response.

Data is at body["result"]

[
  {
    "client_default": "*boolean*",
    "created_at": "*string*",
    "dns_destination_ips_id": "*string*",
    "dns_destination_ipv6_block_id": "*string*",
    "doh_subdomain": "*string*",
    "ecs_support": "*boolean*",
    "endpoints": {
      "doh": null,
      "dot": null,
      "ipv4": null,
      "ipv6": null
    },
    "id": "*string*",
    "ip": "*string*",
    "ipv4_destination": "*string*",
    "ipv4_destination_backup": "*string*",
    "name": "*string*",
    "networks": [
      null
    ],
    "updated_at": "*string*"
  }
]

4XX Lists Zero Trust Gateway locations response failure.

{
  "errors": {},
  "messages": {},
  "result": {},
  "result_info": {
    "count": "*number*",
    "page": "*number*",
    "per_page": "*number*",
    "total_count": "*number*"
  },
  "success": "*boolean*"
}

Update a Zero Trust Gateway location

PUT /accounts/{account_id}/gateway/locations/{location_id}

Update a configured Zero Trust Gateway location.

Responses

200 Updates a Zero Trust Gateway location response.

Data is at body["result"]

{
  "client_default": "*boolean*",
  "created_at": "*string*",
  "dns_destination_ips_id": "*string*",
  "dns_destination_ipv6_block_id": "*string*",
  "doh_subdomain": "*string*",
  "ecs_support": "*boolean*",
  "endpoints": {
    "doh": {
      "enabled": "*boolean*",
      "networks": null,
      "require_token": "*boolean*"
    },
    "dot": {
      "enabled": "*boolean*",
      "networks": null
    },
    "ipv4": {
      "enabled": "*boolean*"
    },
    "ipv6": {
      "enabled": "*boolean*",
      "networks": null
    }
  },
  "id": "*string*",
  "ip": "*string*",
  "ipv4_destination": "*string*",
  "ipv4_destination_backup": "*string*",
  "name": "*string*",
  "networks": [
    {
      "network": "*string*"
    }
  ],
  "updated_at": "*string*"
}

4XX Updates a Zero Trust Gateway location response failure.

{
  "errors": {},
  "messages": {},
  "result": {},
  "success": "*boolean*"
}

Get Zero Trust Gateway location details

GET /accounts/{account_id}/gateway/locations/{location_id}

Get a single Zero Trust Gateway location.

Responses

200 Gets Zero Trust Gateway location details response.

Data is at body["result"]

{
  "client_default": "*boolean*",
  "created_at": "*string*",
  "dns_destination_ips_id": "*string*",
  "dns_destination_ipv6_block_id": "*string*",
  "doh_subdomain": "*string*",
  "ecs_support": "*boolean*",
  "endpoints": {
    "doh": {
      "enabled": "*boolean*",
      "networks": null,
      "require_token": "*boolean*"
    },
    "dot": {
      "enabled": "*boolean*",
      "networks": null
    },
    "ipv4": {
      "enabled": "*boolean*"
    },
    "ipv6": {
      "enabled": "*boolean*",
      "networks": null
    }
  },
  "id": "*string*",
  "ip": "*string*",
  "ipv4_destination": "*string*",
  "ipv4_destination_backup": "*string*",
  "name": "*string*",
  "networks": [
    {
      "network": "*string*"
    }
  ],
  "updated_at": "*string*"
}

4XX Gets Zero Trust Gateway location details response failure.

{
  "errors": {},
  "messages": {},
  "result": {},
  "success": "*boolean*"
}

Delete a Zero Trust Gateway location

DELETE /accounts/{account_id}/gateway/locations/{location_id}

Delete a configured Zero Trust Gateway location.

Responses

200 Deletes a Zero Trust Gateway location response.

Data is at body["result"]

{}

4XX Deletes a Zero Trust Gateway location 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(id, body, opts \\ [])

update!(id, body, opts \\ [])

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(id, body, opts \\ [])

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

update!(id, body, opts \\ [])

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