List of branch sites

POST 
/insights/v3.0/resource/query/sites/rn_list

Retrieves a list of all branch sites along with their details.

Request

Header Parameters

X-PANW-Region stringrequired

Region mapping for the tenant.

Prisma-Tenant string

TSG ID

application/json

Body

required

compute_location string

Compute Location

edge_location_display_name string

Name of PA location

geoip_destination string

Geo IP of the destination

instance_state number

Possible values: [0, 1, 2]

Instance state

site_name string

Name of the site

site_state number

Possible values: [0, 1, 2]

State of the site

Responses

200

OK

application/json

Schema

Schema

avg_throughput number

Average throughput

bgp_all_tunnels number

Count of BGP tunnels

bgp_site_state number

BGP Site State

bgp_site_state_name string

BGP Site State Name

bgp_up_tunnels number

Count of Up Tunnels

compute_location string

Compute Location

destination_ip string

Destination IP

destination_ip_string string

Destination IP

edge_location_display_name string

PA Location

instance_state number

Instance State

instance_state_name string

Instance State Name

median_throughput number

Median throughput

node_type integer

Node Type

peak_throughput number

Peak throughput

site_aggregate_capacity number

Site Aggregate Capacity

site_all_tunnels number

Count of tunnels

site_capacity number

Site Capacity

site_city string

Site City

site_connection_duration number

Site Connection Duration

site_country string

Site Country

site_disconnection number

Site Disconnection

site_location string

Site Location

site_location_string string

Site Location String

site_name string

Site name

site_state number

Site State

site_state_name string

Site State Name

site_type string

Site type

site_up_tunnels number

Count of Up Tunnels

source_ip string

Source IP

source_ip_string string

Source IP

Example (from schema)

{
  "data": [
    {
      "avg_throughput": 85.2,
      "bgp_all_tunnels": 4,
      "bgp_site_state": 1,
      "bgp_site_state_name": "Up",
      "bgp_up_tunnels": 3,
      "compute_location": "US East",
      "destination_ip": "203.0.113.2",
      "destination_ip_string": "203.0.113.2",
      "edge_location_display_name": "US West",
      "instance_state": 1,
      "instance_state_name": "Up",
      "median_throughput": 80.3,
      "node_type": 48,
      "peak_throughput": 160.4,
      "site_aggregate_capacity": 2500,
      "site_all_tunnels": 4,
      "site_capacity": 1500,
      "site_city": "San Francisco",
      "site_connection_duration": 150,
      "site_country": "USA",
      "site_disconnection": 0,
      "site_location": "San Francisco, CA",
      "site_location_string": "San Francisco, CA",
      "site_name": "Remote-Conn2",
      "site_state": 1,
      "site_state_name": "Up",
      "site_type": "Remote Network",
      "site_up_tunnels": 3,
      "source_ip": "203.0.113.1",
      "source_ip_string": "203.0.113.1"
    }
  ]
}

Example

{
  "data": [
    {
      "avg_throughput": 100.5,
      "bgp_all_tunnels": 3,
      "bgp_site_state": 1,
      "bgp_site_state_name": "Up",
      "bgp_up_tunnels": 2,
      "compute_location": "US East",
      "destination_ip": "192.168.1.2",
      "destination_ip_string": "192.168.1.2",
      "edge_location_display_name": "US West",
      "instance_state": 1,
      "instance_state_name": "Up",
      "median_throughput": 95.5,
      "node_type": 48,
      "peak_throughput": 150.5,
      "site_aggregate_capacity": 2000,
      "site_all_tunnels": 3,
      "site_capacity": 1000,
      "site_city": "Denver",
      "site_connection_duration": 120,
      "site_country": "USA",
      "site_disconnection": 0,
      "site_location": "Denver, CO",
      "site_location_string": "Denver, CO",
      "site_name": "Remote-Conn1",
      "site_state": 1,
      "site_state_name": "Up",
      "site_type": "Third-Party",
      "site_up_tunnels": 2,
      "source_ip": "192.168.1.1",
      "source_ip_string": "192.168.1.1"
    }
  ]
}

Loading...