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

Update a configured Zero Trust Gateway location.

Servers

Path parameters

Name Type Required Description
location_id String Yes
account_id String Yes

Request headers

Name Type Required Description
Content-Type String Yes The media type of the request body.

Default value: "application/json"

Request body fields

Name Type Required Description
name String Yes

Specify the location name.

networks[] Array No

Specify the list of network ranges from which requests at this location originate. The list takes effect only if it is non-empty and the IPv4 endpoint is enabled for this location.

networks[].network String Yes

Specify the IPv4 address or IPv4 CIDR. Limit IPv4 CIDRs to a maximum of /24.

client_default Boolean No

Indicate whether this location is the default location.

Default value: false

ecs_support Boolean No

Indicate whether the location must resolve EDNS queries.

Default value: false

dns_destination_ips_id String No

Specify the identifier of the pair of IPv4 addresses assigned to this location. When creating a location, if this field is absent or set to null, the pair of shared IPv4 addresses (0e4a32c6-6fb8-4858-9296-98f51631e8e6) is auto-assigned. When updating a location, if this field is absent or set to null, the pre-assigned pair remains unchanged.

endpoints Object No

Configure the destination endpoints for this location.

endpoints.doh Object Yes
endpoints.doh.networks[] Array No

Specify the list of allowed source IP network ranges for this endpoint. When the list is empty, the endpoint allows all source IPs. The list takes effect only if the endpoint is enabled for this location.

endpoints.doh.networks[].network String Yes

Specify the IP address or IP CIDR.

endpoints.doh.require_token Boolean No

Specify whether the DOH endpoint requires user identity authentication.

endpoints.doh.enabled Boolean No

Indicate whether the DOH endpoint is enabled for this location.

endpoints.ipv4 Object Yes
endpoints.ipv4.enabled Boolean No

Indicate whether the IPv4 endpoint is enabled for this location.

endpoints.ipv6 Object Yes
endpoints.ipv6.networks[] Array No

Specify the list of allowed source IPv6 network ranges for this endpoint. When the list is empty, the endpoint allows all source IPs. The list takes effect only if the endpoint is enabled for this location.

endpoints.ipv6.networks[].network String Yes

Specify the IPv6 address or IPv6 CIDR.

endpoints.ipv6.enabled Boolean No

Indicate whether the IPV6 endpoint is enabled for this location.

endpoints.dot Object Yes
endpoints.dot.networks[] Array No

Specify the list of allowed source IP network ranges for this endpoint. When the list is empty, the endpoint allows all source IPs. The list takes effect only if the endpoint is enabled for this location.

endpoints.dot.networks[].network String Yes

Specify the IP address or IP CIDR.

endpoints.dot.enabled Boolean No

Indicate whether the DOT endpoint is enabled for this location.

How to start integrating

  1. Add HTTP Task to your workflow definition.
  2. Search for the API you want to integrate with and click on the name.
    • This loads the API reference documentation and prepares the Http request settings.
  3. Click Test request to test run your request to the API and see the API's response.