Skip to main content

Get Sites of a Tenant (v4.7)​

Get all the sites of a tenant.

Path Parameters
  • tenant_id string required

    The tenant ID.

Responses

Successful Operation

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 string

    The name of the city. Max size = 100.

  • country string

    The name of the country. Max size = 100.

  • post_code string

    The postal code. Max size = 100.

  • state string

    The name of the state. Max size = 100.

  • street string

    The name of the street. Max size = 100.

  • street2 string

    The name of the street. Max size = 100.

  • admin_state string required

    The 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.

  • description

    Description for the site (Max size = 1024).

  • element_cluster_role string required

    This 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 string

    Key

  • value string

    Value

  • value_type string

    Value Type

  • ]
  • id string

    The ID.

  • location Location

    The geographical cordinates for the site address.

  • description

    The decsription of the location.

  • latitude float

    The latitude of the location. Max range = 90.

  • longitude float

    The longitude of the location. Max range = 180.

  • multicast_peer_group_id string

    The multicast peer group ID.

  • name string required

    The site name (Max size = 128).

  • nat_policysetstack_id string

    ID for the NAT Policyset Stack. Can be retrieved using natpolicysetstack API.

  • network_policysetstack_id string

    ID for the Path Policyset Stack. Can be retrieved using networkpolicysetstack API.

  • policy_set_id string

    The ID for the Original Network Policy Set. Can be retrieved using policysets API.

  • priority_policysetstack_id string

    ID for the QoS Policyset Stack. Can be retrieved using prioritypolicysetstack API.

  • security_policyset_id string

    The ID for the Original Security Policy Set. Can be retrieved using securitypolicysets API.

  • security_policysetstack_id string

    ID for the Security Policyset Stack. Can be retrieved using ngfwpolicysetstack API.

  • service_binding string

    Bind 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.

  • ]
Loading...