Update a sublocation

put

https://{hostname}/etp-config/v3/configs/{configId}/sites/{siteId}/sub-locations/{subLocationId}

Updates the sublocation.

Path Params

subLocationId

integer

required

A unique identifier for a location.

siteId

integer

required

A unique identifier for a site.

configId

integer

required

A unique identifier for the configuration.

Query Params

accountSwitchKey

string

For customers who manage more than one account, this runs the operation from another account. The Identity and Access Management API provides a list of available account switch keys.

Body Params

Specifies IP addresses and CIDR blocks of a region or geographic area for an assigned policy.

accessConfig

object

Provides access config details.

clientOverridePolicyId

integer

≥ 0

The unique ID of the related client override policy.

clientOverridePolicyInfo

object

The unique policy for handling the traffic arriving from Zero Trust Client or SIA Client.

createdBy

string

length ≥ 1

Name of the user who created this site.

deleted

boolean

Indicates the site's deletion.

description

string

length ≥ 1

A description of the site configuration that you provide.

dynamicExitPoints

array of objects

length ≥ 0

A site's dynamic exit points.

dynamicExitPoints

dynamicIpEnabled

boolean

Enables dynamic IP onramp for the site.

exitPoints

array of objects

required

length ≥ 0

Site exit points.

exitPoints*

integer

≥ 1

A unique identifier for the site. Use this value for siteId in subsequent operations.

ipsecOnrampcredential

object

IPsec credential properties.

ipsecOverDNSEnabled

boolean

Enables IPsec over DNS for the site.

isOffnetworkLocation

boolean

Indicates if the site is an off-network location.

modifiedBy

string

length ≥ 1

Name of the user who most recently modified this site.

name

string

required

length ≥ 1

The name of the site configuration.

policyId

integer

required

≥ 1

The unique ID of the related policy.

policyInfo

object

Specifies the related policy SIA applies to incoming DNS requests.

subLocations

array of objects

length ≥ 0

Nested sublocation instances.

subLocations

useInternalIpPrivacyMask

boolean

Applies internal IP privacy mask.

Headers

If-Match

string

required

Use the x_etag value included in the GET response. See Concurrency control for details.

Responses

200

Successful response.

400Validation error.

401Authentication error. See Get started for help setting up your API token.

403Insufficient permissions See Get started for help setting up your API token.

404Configuration not Found.

412Precondition failed. Use the x_etag string returned in the response header as If-Match in write requests to avoid overwriting edits by any other API clients. See Concurrency control for details.