Update a Site (v4.8)

PUT 
/v4.8/api/tenants/:tenant_id/sites/:site_id

Update an existing site.

Request

Path Parameters

tenant_id stringrequired

The tenant ID.

site_id stringrequired

ID of the site. More details on the site can be retrieved by querying the sites API.

application/json

Body

Details of the site to update

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 stringrequired

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 stringrequired

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 stringrequired

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

Security Policyset Id

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.

vrf_context_profile_id string

The VRF (Virtual Routing and Forwarding) profile ID.

Responses

200

Successful Operation

application/json

Schema

Schema

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 stringrequired

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 stringrequired

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 stringrequired

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.

vrf_context_profile_id string

The VRF (Virtual Routing and Forwarding) profile ID.

Example (from schema)

{
  "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"
  ],
  "vrf_context_profile_id": "string"
}

400

Bad Request

application/json

Schema

Schema

_error ErrorResponse[]
Array [
code string
The error code.
message string
The error message.
]

Example (from schema)

{
  "_error": [
    {
      "code": "string",
      "message": "string"
    }
  ]
}

Example

{
  "value": {
    "_error": [
      {
        "code": "POLICY_CONFIG_INVALID_FOR_HUB_SITE"
      },
      {
        "code": "INVALID_SECURITY_POLICYSET"
      },
      {
        "code": "INVALID_POLICY_CONFIGURATION"
      },
      {
        "code": "INVALID_NETWORK_POLICYSETSTACK"
      },
      {
        "code": "NGFWSETSTACK_NOT_FOUND"
      },
      {
        "code": "DEFAULT_NETWORK_POLICYSETSTACK_NOT_AVAILABLE"
      },
      {
        "code": "INVALID_PRIORITY_POLICYSETSTACK"
      },
      {
        "code": "DEFAULT_PRIORITY_POLICYSETSTACK_NOT_AVAILABLE"
      },
      {
        "code": "POLICYSETSTACK_CONFIG_NOT_SUPPORTED"
      },
      {
        "code": "DEFAULT_POLICY_NOT_CONFIGURED"
      },
      {
        "code": "SITE_CONFIG_SERVICEBINDING_INVALID_FOR_HUB"
      },
      {
        "code": "SITE_CONFIG_SERVICEBINDING_DOES_NOT_EXIST"
      },
      {
        "code": "SITE_STATE_INVALID"
      },
      {
        "code": "SITE_ELEMENT_CLUSTER_ROLE_UPDATE_NOT_ALLOWED"
      },
      {
        "code": "INVALID_POLICYSET"
      },
      {
        "code": "INVALID_JSON_EXTRA_ATTRIBUTE"
      },
      {
        "code": "INVALID_JSON_COMMON_ATTR_MISMATCH"
      },
      {
        "code": "MULTICAST_INVALID_PEER_GROUP_ID"
      }
    ]
  }
}

Loading...