Update a Site (v4.2)

Update an existing site.

Path Parameters

tenant_id string required
The tenant ID.
site_id string required
ID of the site. More details on the site can be retrieved by querying the sites API.

application/json

Request 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 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.
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.
name string required
The site name (Max size = 128).
network_policysetstack_id string
The 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 policy sets 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 security policy sets API.
service_binding string
Bind a site to a set of domains. Can be retrieved using sericebindingmaps API.

Responses

Successful Operation

application/json

Schema
Example (from 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 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.
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.
name string required
The site name (Max size = 128).
network_policysetstack_id string
The 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 policy sets 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 security policy sets API.
service_binding string
Bind a site to a set of domains. Can be retrieved using sericebindingmaps API.

{
  "address": {
    "city": "string",
    "country": "string",
    "post_code": "string",
    "state": "string",
    "street": "string",
    "street2": "string"
  },
  "admin_state": "string",
  "element_cluster_role": "string",
  "id": "string",
  "location": {
    "latitude": 0,
    "longitude": 0
  },
  "name": "string",
  "network_policysetstack_id": "string",
  "policy_set_id": "string",
  "priority_policysetstack_id": "string",
  "security_policyset_id": "string",
  "service_binding": "string"
}

Bad Request

application/json

Schema
Example (from schema)
Example

Schema

_error ErrorResponse[]
Array [
code string
message string
]

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

{
  "value": {
    "_error": [
      {
        "code": "SITE_NOT_FOUND"
      },
      {
        "code": "INVALID_JSON_EXTRA_ATTRIBUTE"
      },
      {
        "code": "INVALID_JSON_COMMON_ATTR_MISMATCH"
      }
    ]
  }
}

Update a Site (v4.2)​

Update a Site (v4.2)