Get an Auto VPN cluster

GET 
/auto-vpn-clusters/:id

Get an existing Auto VPN clusters.

Request

Path Parameters

id uuidrequired

The UUID of the configuration resource

Responses

200

OK

application/json

Schema

Schema

id string

UUID of the resource

name string

VPN cluster name

enable_sdwan boolean

Enable SD-WAN?

type string

Possible values: [hub-spoke]

Default value: hub-spoke

VPN cluster type (only hub-spoke is supported today)

branches object[]
Branches
Array [
name string
Branch firewall serial number
site string
Site name
logical_router string
Router
bgp_redistribution_profile string
BGP redistribution profile
interfaces object[]
Possible values: <= 4
Interfaces
Array [
name string
Ethernet interface
sdwan_link_settings object
sdwan_interface_profile string
SD-WAN interface profile
upstream_nat object
enable boolean
Upstream NAT?
static_ip object
oneOf
ip_address
ip_address string
IP address
fqdn
fqdn string
FQDN
sdwan_gateway string
Next hop gateway
]
private_interfaces object[]
Possible values: <= 4
Private interfaces
Array [
name string
Ethernet interface
sdwan_link_settings object
sdwan_interface_profile string
SD-WAN interface profile
upstream_nat object
enable boolean
Upstream NAT?
static_ip object
oneOf
ip_address
ip_address string
IP address
fqdn
fqdn string
FQDN
sdwan_gateway string
Next hop gateway
]
]
gateways object[]
Hubs
Array [
name string
Hub firewall serial number
site string
Site name
priority integer
Possible values: >= 1 and <= 8
Priority
logical_router string
Router
bgp_redistribution_profile string
BGP redistribution file
allow_dia_vpn_failover boolean
Allow DIA to VPN failover on branch device for the hub?
interfaces object[]
Interfaces
Array [
name string
Ethernet interface
sdwan_link_settings object
sdwan_interface_profile string
SD-WAN interface profile
upstream_nat object
enable boolean
Upstream NAT?
static_ip object
oneOf
ip_address
ip_address string
IP address
fqdn
fqdn string
FQDN
sdwan_gateway string
Next hop gateway
]
private_interfaces object[]
Private interfaces
Array [
name string
Ethernet interface
sdwan_link_settings object
sdwan_interface_profile string
SD-WAN interface profile
upstream_nat object
enable boolean
Upstream NAT?
static_ip object
oneOf
ip_address
ip_address string
IP address
fqdn
fqdn string
FQDN
sdwan_gateway string
Next hop gateway
]
]

Example (from schema)

{
  "id": "123e4567-e89b-12d3-a456-426655440000",
  "name": "string",
  "enable_sdwan": true,
  "type": "hub-spoke",
  "branches": [
    {
      "name": "string",
      "site": "string",
      "logical_router": "string",
      "bgp_redistribution_profile": "string",
      "interfaces": [
        {
          "name": "string",
          "sdwan_link_settings": {
            "sdwan_interface_profile": "string",
            "upstream_nat": {
              "enable": false
            },
            "sdwan_gateway": "string"
          }
        }
      ],
      "private_interfaces": [
        {
          "name": "string",
          "sdwan_link_settings": {
            "sdwan_interface_profile": "string",
            "upstream_nat": {
              "enable": false
            },
            "sdwan_gateway": "string"
          }
        }
      ]
    }
  ],
  "gateways": [
    {
      "name": "string",
      "site": "string",
      "priority": 0,
      "logical_router": "string",
      "bgp_redistribution_profile": "string",
      "allow_dia_vpn_failover": true,
      "interfaces": [
        {
          "name": "string",
          "sdwan_link_settings": {
            "sdwan_interface_profile": "string",
            "upstream_nat": {
              "enable": true
            },
            "sdwan_gateway": "string"
          }
        }
      ],
      "private_interfaces": [
        {
          "name": "string",
          "sdwan_link_settings": {
            "sdwan_interface_profile": "string",
            "upstream_nat": {
              "enable": true
            },
            "sdwan_gateway": "string"
          }
        }
      ]
    }
  ]
}

400

Bad Request

application/json

Schema

Schema

_errors object[]
Array [
code string
message string
details object
help string
]
_request_id string

Example (from schema)

{
  "_errors": [
    {
      "code": "string",
      "message": "string",
      "details": {},
      "help": "string"
    }
  ],
  "_request_id": "string"
}

input_format_mismatch

Input Format Mismatch

{
  "_errors": [
    {
      "code": "E003",
      "message": "Input Format Mismatch: input-format=json",
      "details": {}
    }
  ],
  "_request_id": "123e4567-e89b-12d3-a456-426655440000"
}

output_format_mismatch

Output Format Mismatch

{
  "_errors": [
    {
      "code": "E003",
      "message": "Output Format Mismatch: output-format=json Accept=xml",
      "details": {}
    }
  ],
  "_request_id": "123e4567-e89b-12d3-a456-426655440000"
}

missing_query_parameter

Missing Query Parameter

{
  "_errors": [
    {
      "code": "E003",
      "message": "Missing Query Parameter: name",
      "details": {}
    }
  ],
  "_request_id": "123e4567-e89b-12d3-a456-426655440000"
}

invalid_query_parameter

Invalid Query Parameter

{
  "_errors": [
    {
      "code": "E003",
      "message": "Invalid Query Parameter: location=invalid",
      "details": {}
    }
  ],
  "_request_id": "123e4567-e89b-12d3-a456-426655440000"
}

401

Unauthorized

application/json

Schema

Schema

_errors object[]
Array [
code string
message string
details object
help string
]
_request_id string

Example (from schema)

{
  "_errors": [
    {
      "code": "string",
      "message": "string",
      "details": {},
      "help": "string"
    }
  ],
  "_request_id": "string"
}

auth_not_authenticated

Not Authenticated

{
  "_errors": [
    {
      "code": "E016",
      "message": "Not Authenticated",
      "details": {}
    }
  ],
  "_request_id": "123e4567-e89b-12d3-a456-426655440000"
}

invalid_credential

Invalid Credential

{
  "_errors": [
    {
      "code": "E016",
      "message": "Invalid Credential",
      "details": {}
    }
  ],
  "_request_id": "123e4567-e89b-12d3-a456-426655440000"
}

key_too_long

Key Too Long

{
  "_errors": [
    {
      "code": "E016",
      "message": "Key Too Long",
      "details": {}
    }
  ],
  "_request_id": "123e4567-e89b-12d3-a456-426655440000"
}

key_expired

Key Expired

{
  "_errors": [
    {
      "code": "E016",
      "message": "Key Expired",
      "details": {}
    }
  ],
  "_request_id": "123e4567-e89b-12d3-a456-426655440000"
}

need_password_change

Need Password Change

{
  "_errors": [
    {
      "code": "E016",
      "message": "The password needs to be changed.",
      "details": {}
    }
  ],
  "_request_id": "123e4567-e89b-12d3-a456-426655440000"
}

403

Forbidden

application/json

Schema

Schema

_errors object[]
Array [
code string
message string
details object
help string
]
_request_id string

Example (from schema)

{
  "_errors": [
    {
      "code": "string",
      "message": "string",
      "details": {},
      "help": "string"
    }
  ],
  "_request_id": "string"
}

auth_unauthorized

Unauthorized

{
  "_errors": [
    {
      "code": "E007",
      "message": "Unauthorized",
      "details": {}
    }
  ],
  "_request_id": "123e4567-e89b-12d3-a456-426655440000"
}

404

Not Found

application/json

Schema

Schema

_errors object[]
Array [
code string
message string
details object
help string
]
_request_id string

Example (from schema)

{
  "_errors": [
    {
      "code": "string",
      "message": "string",
      "details": {},
      "help": "string"
    }
  ],
  "_request_id": "string"
}

object_not_present

Object Not Present

{
  "_errors": [
    {
      "code": "E005",
      "message": "Object Not Present",
      "details": {}
    }
  ],
  "_request_id": "123e4567-e89b-12d3-a456-426655440000"
}

default

General Errors

application/json

Schema

Schema

_errors object[]
Array [
code string
message string
details object
help string
]
_request_id string

Example (from schema)

{
  "_errors": [
    {
      "code": "string",
      "message": "string",
      "details": {},
      "help": "string"
    }
  ],
  "_request_id": "string"
}

version_not_supported

Version Not Supported

{
  "_errors": [
    {
      "code": "E012",
      "message": "Version Not Supported",
      "details": {}
    }
  ],
  "_request_id": "123e4567-e89b-12d3-a456-426655440000"
}

method_not_allowed

Method Not Supported

{
  "_errors": [
    {
      "code": "E012",
      "message": "Method Not Supported",
      "details": {}
    }
  ],
  "_request_id": "123e4567-e89b-12d3-a456-426655440000"
}

action_not_supported

Action Not Supported

{
  "_errors": [
    {
      "code": "E012",
      "message": "Action Not Supported: move",
      "details": {}
    }
  ],
  "_request_id": "123e4567-e89b-12d3-a456-426655440000"
}

bad_xpath

Bad XPath

{
  "_errors": [
    {
      "code": "E013",
      "message": "Bad XPath",
      "details": {}
    }
  ],
  "_request_id": "123e4567-e89b-12d3-a456-426655440000"
}

invalid_command

Invalid Command

{
  "_errors": [
    {
      "code": "E003",
      "message": "Invalid Command",
      "details": {}
    }
  ],
  "_request_id": "123e4567-e89b-12d3-a456-426655440000"
}

malformed_command

Malformed Command

{
  "_errors": [
    {
      "code": "E003",
      "message": "Malformed Command",
      "details": {}
    }
  ],
  "_request_id": "123e4567-e89b-12d3-a456-426655440000"
}

session_timeout

Session Timeout

{
  "_errors": [
    {
      "code": "4",
      "message": "Session Timeout",
      "details": {}
    }
  ],
  "_request_id": "123e4567-e89b-12d3-a456-426655440000"
}

Loading...