Get Sites of a Tenant (v4.7)
Get all the sites of a tenant.
Path Parameters
- tenant_id string required
The tenant ID.
- 200
Successful Operation
- application/json
- Schema
- Example (from schema)
Schema
- count int32
The total number of responses.
- id string
The ID of the response.
- type string
The type of response.
items SiteV4N7[]
Array [address Address
The address of the site.
city stringThe name of the city. Max size = 100.
country stringThe name of the country. Max size = 100.
post_code stringThe postal code. Max size = 100.
state stringThe name of the state. Max size = 100.
street stringThe name of the street. Max size = 100.
street2 stringThe name of the street. Max size = 100.
admin_state string requiredThe site mode of operation, can be in one of three states: Active - the site is in Control mode and network policy is applied. Monitor - the site is in Analytics mode, no network policy is applied. Disabled: the site is disabled.
descriptionDescription for the site (Max size = 1024).
element_cluster_role string requiredThis attribute describes the type i.e. SPOKE or HUB.
extended_tags ExtendedTag[]
Extended tags allow operators to add more information into the site object. Current extended tags allow for additional configuration related to Prisma Access and ZScaler to be added.
Array [key stringKey
value stringValue
value_type stringValue Type
]id stringThe ID.
location Location
The geographical cordinates for the site address.
descriptionThe decsription of the location.
latitude floatThe latitude of the location. Max range = 90.
longitude floatThe longitude of the location. Max range = 180.
multicast_peer_group_id stringThe multicast peer group ID.
name string requiredThe site name (Max size = 128).
nat_policysetstack_id stringID for the NAT Policyset Stack. Can be retrieved using natpolicysetstack API.
network_policysetstack_id stringID for the Path Policyset Stack. Can be retrieved using networkpolicysetstack API.
policy_set_id stringThe ID for the Original Network Policy Set. Can be retrieved using policysets API.
priority_policysetstack_id stringID for the QoS Policyset Stack. Can be retrieved using prioritypolicysetstack API.
security_policyset_id stringThe ID for the Original Security Policy Set. Can be retrieved using securitypolicysets API.
security_policysetstack_id stringID for the Security Policyset Stack. Can be retrieved using ngfwpolicysetstack API.
service_binding stringBind a site to a set of domains. Can be retrieved using sericebindingmaps API.
tags string[]A information field that can be added to identify the site.
]
{
"count": 0,
"id": "string",
"type": "string",
"items": [
{
"address": {
"city": "string",
"country": "string",
"post_code": "string",
"state": "string",
"street": "string",
"street2": "string"
},
"admin_state": "string",
"element_cluster_role": "string",
"extended_tags": [
{
"key": "string",
"value": "string",
"value_type": "string"
}
],
"id": "string",
"location": {
"latitude": 0,
"longitude": 0
},
"multicast_peer_group_id": "string",
"name": "string",
"nat_policysetstack_id": "string",
"network_policysetstack_id": "string",
"policy_set_id": "string",
"priority_policysetstack_id": "string",
"security_policyset_id": "string",
"security_policysetstack_id": "string",
"service_binding": "string",
"tags": [
"string"
]
}
]
}