POST /accounts/{account_id}/gateway/locations
Creates a new Zero Trust Gateway location.
Servers
- https://api.cloudflare.com/client/v4
Path parameters
| Name | Type | Required | Description |
|---|---|---|---|
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 |
The name of the location. |
networks[] |
Array | No |
A list of network ranges that requests from this location would originate from. A non-empty list is only effective if the ipv4 endpoint is enabled for this location. |
networks[].network |
String | Yes |
The IPv4 address or IPv4 CIDR. IPv4 CIDRs are limited to a maximum of /24. |
client_default |
Boolean | No |
True if the location is the default location. Default value: false |
ecs_support |
Boolean | No |
True if the location needs to resolve EDNS queries. Default value: false |
dns_destination_ips_id |
String | No |
The identifier of the pair of IPv4 addresses assigned to this location. When creating a location, if this field is absent or set with null, the pair of shared IPv4 addresses (0e4a32c6-6fb8-4858-9296-98f51631e8e6) is auto-assigned. When updating a location, if the field is absent or set with null, the pre-assigned pair remains unchanged. |
endpoints |
Object | No |
The destination endpoints configured for this location. When updating a location, if this field is absent or set with null, the endpoints configuration remains unchanged. |
endpoints.doh |
Object | No | |
endpoints.doh.networks[] |
Array | No |
A list of allowed source IP network ranges for this endpoint. When empty, all source IPs are allowed. A non-empty list is only effective if the endpoint is enabled for this location. |
endpoints.doh.networks[].network |
String | Yes |
The IP address or IP CIDR. |
endpoints.doh.require_token |
Boolean | No |
True if the endpoint requires user identity authentication. |
endpoints.doh.enabled |
Boolean | No |
True if the endpoint is enabled for this location. |
endpoints.ipv4 |
Object | No | |
endpoints.ipv4.enabled |
Boolean | No |
True if the endpoint is enabled for this location. |
endpoints.ipv6 |
Object | No | |
endpoints.ipv6.networks[] |
Array | No |
A list of allowed source IPv6 network ranges for this endpoint. When empty, all source IPs are allowed. A non-empty list is only effective if the endpoint is enabled for this location. |
endpoints.ipv6.networks[].network |
String | Yes |
The IPv6 address or IPv6 CIDR. |
endpoints.ipv6.enabled |
Boolean | No |
True if the endpoint is enabled for this location. |
endpoints.dot |
Object | No | |
endpoints.dot.networks[] |
Array | No |
A list of allowed source IP network ranges for this endpoint. When empty, all source IPs are allowed. A non-empty list is only effective if the endpoint is enabled for this location. |
endpoints.dot.networks[].network |
String | Yes |
The IP address or IP CIDR. |
endpoints.dot.enabled |
Boolean | No |
True if the endpoint is enabled for this location. |
How to start integrating
- Add HTTP Task to your workflow definition.
- 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.
- Click Test request to test run your request to the API and see the API's response.