Delete a Site (v4.10)
DELETEhttps://api.sase.paloaltonetworks.com/sdwan/v4.10/api/sites/:site_id
Delete a particular site.
Request
Path Parameters
ID of the site. More details on the site can be retrieved by querying the sites API.
Responses
- 200
- 400
Successful Operation
- application/json
- Schema
- Example (auto)
Schema
address Address
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.
Branch gateway enabled or not.
Description for the site (Max size = 1024).
This attribute describes the type i.e. SPOKE or HUB.
extended_tags ExtendedTag[]
The ID.
location Location
The multicast peer group ID.
The site name (Max size = 128).
ID for the NAT Policyset Stack. Can be retrieved using natpolicysetstack API.
ID for the Path Policyset Stack. Can be retrieved using networkpolicysetstack API.
ID for the Performance Policyset Stack.
The ID for the Original Network Policy Set. Can be retrieved using policysets API.
Prefer Lan Default Over Wan Default Route
ID for the QoS Policyset Stack. Can be retrieved using prioritypolicysetstack API.
The ID for the Original Security Policy Set. Can be retrieved using securitypolicysets API.
ID for the Security Policyset Stack. Can be retrieved using ngfwpolicysetstack API.
Bind a site to a set of domains. Can be retrieved using sericebindingmaps API.
A information field that can be added to identify the site.
The VRF (Virtual Routing and Forwarding) profile ID.
{
"address": {
"city": "string",
"country": "string",
"post_code": "string",
"state": "string",
"street": "string",
"street2": "string"
},
"admin_state": "string",
"branch_gateway": true,
"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",
"perfmgmt_policysetstack_id": "string",
"policy_set_id": "string",
"prefer_lan_default_over_wan_default_route": true,
"priority_policysetstack_id": "string",
"security_policyset_id": "string",
"security_policysetstack_id": "string",
"service_binding": "string",
"tags": [
"string"
],
"vrf_context_profile_id": "string"
}
Bad Request
- application/json
- Schema
- Example (auto)
- Example
Schema
_error ErrorResponse[]
{
"_error": [
{
"code": "string",
"message": "string"
}
]
}
{
"value": {
"_error": [
{
"code": "SITE_NOT_FOUND"
},
{
"code": "UNKNOWN_SITE"
},
{
"code": "DELETE_FORBIDDEN_INVALID_STATE"
},
{
"code": "DELETE_FORBIDDEN_SITE_WAN_EXISTS"
},
{
"code": "DELETE_FORBIDDEN_SITE_WAN_LQM_CONFIG_EXISTS"
},
{
"code": "DELETE_FORBIDDEN_ELEMENT_OR_ELEMENT_SHELL_EXISTS"
},
{
"code": "SITE_CONFIG_DELETE_NOTALLOWED_SERVICEENDPOINT_EXISTS"
}
]
}
}
- curl
- python
- go
- nodejs
- csharp
- php
- CURL
curl -L -X DELETE 'https://api.sase.paloaltonetworks.com/sdwan/v4.10/api/sites/:site_id' \
-H 'Accept: application/json'