Create a New Site (v4.10)
POST/sdwan/v4.10/api/sites
Create a new site.
Request
- application/json
Body
Details of the site to be created
- Array [
- ]
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.
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[]
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.
Key
Value
Value Type
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 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.
Responses
- 200
- 400
Successful Operation
- application/json
- Schema
- Example (from schema)
Schema
- Array [
- ]
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.
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[]
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.
Key
Value
Value Type
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 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 (from schema)
- Example
Schema
- Array [
- ]
_error ErrorResponse[]
The error code.
The error message.
{
"_error": [
{
"code": "string",
"message": "string"
}
]
}
{
"value": {
"_error": [
{
"code": "INVALID_JSON_EXTRA_ATTRIBUTE"
},
{
"code": "INVALID_SITE_CONFIG"
},
{
"code": "POLICY_NOT_AVAILABLE"
},
{
"code": "NGFWSETSTACK_NOT_FOUND"
},
{
"code": "SITE_STATE_INVALID"
},
{
"code": "MULTICAST_INVALID_PEER_GROUP_ID"
},
{
"code": "SITE_CONFIG_PERFMGMT_POLICY_NOT_SUPPORTED"
},
{
"code": "SITE_CONFIG_PERFMGMT_POLICYSETSTACK_FORBIDDEN"
},
{
"code": "SITE_CONFIG_PERFMGMT_POLICYSETSTACK_NOT_FOUND"
},
{
"code": "PERFMGMT_DEFAULT_STACK_NOT_FOUND"
},
{
"code": "CANNOT_ENABLE_LAN_DEFAULT_OVER_WAN_DEFAULT_ROUTE"
},
{
"code": "BRANCH_GATEWAY_CAN_BE_ENABLED_FOR_SPOKE_ONLY"
},
{
"code": "BRANCH_GATEWAY_CANNOT_BE_ENABLED_FOR_MONITOR_MODE"
}
]
}
}