Update a Site (v3.0)
PUT/sdwan/v3.0/api/sites/:site_id/admin_state
Update an existing site.
Request
Path Parameters
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.
The name of the city. Max size = 100.
The name of the country. Max size = 100.
The postal code. Max size = 100.
The name of the state. Max size = 100.
The name of the street. Max size = 100.
The name of the street. Max size = 100.
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 for the site (Max size = 1024).
This attribute describes the type i.e. SPOKE or HUB.
The ID.
location Location
The geographical cordinates for the site address.
The description of the location.
The latitude of the location. Max range = 90.
The longitude of the location. Max range = 180.
The site name (Max size = 128).
The ID for the Original Network Policy Set. Can be retrieved using policysets API.
The ID for the Original Security Policy Set. Can be retrieved using securitypolicysets API.
Bind a site to a set of domains. Can be retrieved using sericebindingmaps API.
Responses
- 200
- 400
Successful Operation
- application/json
- Schema
- Example (from schema)
Schema
address Address
The address of the site.
The name of the city. Max size = 100.
The name of the country. Max size = 100.
The postal code. Max size = 100.
The name of the state. Max size = 100.
The name of the street. Max size = 100.
The name of the street. Max size = 100.
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 for the site (Max size = 1024).
This attribute describes the type i.e. SPOKE or HUB.
The ID.
location Location
The geographical cordinates for the site address.
The description of the location.
The latitude of the location. Max range = 90.
The longitude of the location. Max range = 180.
The site name (Max size = 128).
The ID for the Original Network Policy Set. Can be retrieved using policysets API.
The ID for the Original Security Policy Set. Can be retrieved using securitypolicysets API.
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",
"policy_set_id": "string",
"security_policyset_id": "string",
"service_binding": "string"
}
Bad Request
- application/json
- Schema
- Example (from schema)
- Example
Schema
- Array [
- ]
_error ErrorResponse[]
The error code.
The error message.
{
"_error": [
{
"code": "string",
"message": "string"
}
]
}
{
"value": {
"_error": [
{
"code": "SITE_NOT_FOUND"
},
{
"code": "INVALID_JSON_EXTRA_ATTRIBUTE"
},
{
"code": "INVALID_JSON_COMMON_ATTR_MISMATCH"
}
]
}
}