OrgsVPNs
createOrgVpn
Create Org VPN
Authorization<token>
Preferred authentication method for automation and integrations. Send the API token in the HTTP Authorization header.
Format:
Authorization: Token {apitoken}
Notes:
- An API token generated for a specific admin has the same privileges as that admin
- An API token is automatically removed if it is not used for more than 90 days
- SSO admins cannot generate admin API tokens. Use organization API tokens when scoped Org/Site privileges are needed.
In: header
Path Parameters
org_id*string
Format
uuidRequest Body
application/json
Organization VPN overlay configuration
name*string
Display name of the VPN configuration
Length
1 <= lengthpath_selection?
Path selection settings used when type==hub_spoke
paths*
VPN path definitions keyed by VPN name for hub_spoke mode or interface name for mesh mode
type?vpn_mode
VPN topology mode for this configuration. enum: hub_spoke, mesh.
Default
"hub_spoke"Value in
- "hub_spoke"
- "mesh"
Response Body
curl -X POST "https://example.com/api/v1/orgs/000000ab-00ab-00ab-00ab-0000000000ab/vpns" \ -H "Content-Type: application/json" \ -d '{ "name": "string", "paths": { "property1": { "bfd_profile": "broadband", "ip": "string" }, "property2": { "bfd_profile": "lte", "ip": "string" } } }'{ "created_time": 0, "id": "497f6eca-6276-5009-bfeb-53cbbbba6f1b", "modified_time": 0, "name": "string", "org_id": "a40f5d1f-d889-42e9-94ea-b9b33585fc6b", "paths": { "property1": { "bfd_profile": "broadband", "ip": "string" }, "property2": { "bfd_profile": "broadband", "ip": "string" } }}