List sites

get

https://{hostname}/etp-config/v3/configs/{configId}/sites

Returns all sites for a configuration.

Responses

Response body

array of objects

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

object

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.

createdDate

date-time

Read-only ISO 8601 timestamp marking this site's creation.

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

object

addrType

string

enum

required

The IP address type, either ADDR_TYPE_IPV4 or ADDR_TYPE_IPV6.

ADDR_TYPE_IPV4 ADDR_TYPE_IPV6

ipAddr

string

required

length ≥ 1

The IP address or CIDR block for your company used to match a policy to a request.

dynamicIpEnabled

boolean

Enables dynamic IP onramp for the site.

exitPoints

array of objects

required

length ≥ 0

Site exit points.

exitPoints*

object

addrType

string

enum

required

The IP address type, either ADDR_TYPE_IPV4 or ADDR_TYPE_IPV6.

ADDR_TYPE_IPV4 ADDR_TYPE_IPV6

ipAddr

string

required

length ≥ 1

The IP address or CIDR block for your company used to match a policy to a request.

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.

modifiedDate

date-time

Read-only ISO 8601 timestamp marking this site's last modification.

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

object

accessConfig

object

required

Provides access configuration details.

createdBy

string

length ≥ 1

Name of the user who created the sublocation.

createdDate

string

length ≥ 1

ISO 8601 timestamp marking the sublocation's creation.

exitPoints

array of objects

required

length ≥ 0

Site sublocation exit points.

exitPoints*

object

addrType

string

required

length ≥ 1

The IP address type, either ADDR_TYPE_IPV4 or ADDR_TYPE_IPV6.

ipAddr

string

required

length ≥ 1

The IP address.

integer

≥ 1

The sublocation's unique ID. Use this value for siteId in subsequent operations.

isOffnetworkLocation

boolean

required

Indicates if the site is an off-network location.

modifiedBy

string

length ≥ 1

Name of the user who last modified the sublocation.

modifiedDate

string

length ≥ 1

ISO 8601 timestamp marking the sublocation's last modification.

name

string

required

length ≥ 1

The sublocation name.

policyId

integer

required

≥ 1

The unique ID of the related policy.

policyInfo

object

required

Policy details.

subLocations

array of strings

required

length ≥ 0

Nested sublocation instances.

useInternalIpPrivacyMask

boolean

Applies internal IP privacy mask.

Language

URL


xxxxxxxxxx
1
curl --request GET \
2
     --url https://hostname/etp-config/v3/configs/configId/sites \
3
     --header 'accept: application/json'


xxxxxxxxxx
73
]
1
[
2
  {
3
    "accessConfig": {
4
      "configurable": true,
5
      "delegatedAdmins": [],
6
      "readable": true
7
    },
8
    "clientOverridePolicyId": 32987,
9
    "clientOverridePolicyInfo": {
10
      "id": 32987,
11
      "name": "Policy_corp"
12
    },
13
    "createdBy": "szhang",
14
    "createdDate": "2022-03-04T12:21:12.299+00:00",
15
    "exitPoints": [
16
      {
17
        "addrType": "ADDR_TYPE_IPV4",
18
        "ipAddr": "192.0.2.228"
19
      },
20
      {
21
        "addrType": "ADDR_TYPE_IPV4",
22
        "ipAddr": "192.0.2.203"
23
      },
24
      {
25
        "addrType": "ADDR_TYPE_IPV4",
26
        "ipAddr": "192.0.2.171"
27
      },
28
      {
29
        "addrType": "ADDR_TYPE_IPV6",
30
        "ipAddr": "2001:db8:53ff:142f:6a84:6d6d:4a9b:6ff4"
31
      }
32
    ],
33
    "id": 10959874,
34
    "isOffnetworkLocation": false,
35
    "modifiedBy": "hgildong",
36
    "modifiedDate": "2022-11-23T15:17:28.337+00:00",
37
    "name": "IPsec Ubuntu",
38
    "policyId": 32986,
39
    "policyInfo": {
40
      "id": 32986,
41
      "name": "IPSec staging Setup"
42
    },
43
    "subLocations": [
44
      {
45
        "accessConfig": {
46
          "configurable": true,
47
          "delegatedAdmins": [],
48
          "readable": true
49
        },

200Successful 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.

409Conflict with current state of resource. 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.