List IPSec tunnels
Retrieve IPSec tunnels.
Query Parameters
- limit number
The maximum number of result objects to return per page.
- offset number
The offset of the result entry.
- name string
The name of the entry.
- folder string required
Possible values: Value must match regular expression
^[0-9a-zA-Z._-\s]{1,}$
, [Shared
,Mobile Users
,Remote Networks
,Service Connections
,Mobile Users Container
,Mobile Users Explicit Proxy
]The folder on which you want to perform this operation.
- 200
- 400
- 401
- 403
- 404
- default
List of ipsec tunnels
- application/json
- Schema
- Example (from schema)
Schema
data object[]
Array [anti_replay booleanEnable Anti-Replay check on this tunnel
auto_key object required
ike_gateway object[] required
Array [name string]ipsec_crypto_profile string requiredproxy_id object[]
IPv4 type of proxy_id values
Array [local stringname string requiredprotocol object
- oneOf
- number
- tcp
- udp
number integerPossible values:
>= 1
and<= 254
IP protocol number
tcp object
local_port integerPossible values:
<= 65535
Default value:
0
remote_port integerPossible values:
<= 65535
Default value:
0
udp object
local_port integerPossible values:
<= 65535
Default value:
0
remote_port integerPossible values:
<= 65535
Default value:
0
remote string]proxy_id_v6 object[]
IPv6 type of proxy_id values
Array [local stringname string requiredprotocol object
- oneOf
- number
- tcp
- udp
number integerPossible values:
>= 1
and<= 254
IP protocol number
tcp object
local_port integerPossible values:
<= 65535
Default value:
0
remote_port integerPossible values:
<= 65535
Default value:
0
udp object
local_port integerPossible values:
<= 65535
Default value:
0
remote_port integerPossible values:
<= 65535
Default value:
0
remote string]copy_tos booleanDefault value:
false
Copy IP TOS bits from inner packet to IPSec packet (not recommended)
enable_gre_encapsulation booleanDefault value:
false
allow GRE over IPSec
id stringuuid of the resource
name string requiredPossible values:
<= 63 characters
Alphanumeric string begin with letter: [0-9a-zA-Z._-]
tunnel_monitor object
destination_ip string requiredDestination IP to send ICMP probe
enable booleanDefault value:
true
Enable tunnel monitoring on this tunnel
proxy_id stringWhich proxy-id (or proxy-id-v6) the monitoring traffic will use
]- limit number
Default value:
200
- offset number
Default value:
0
- total number
{
"data": [
{
"anti_replay": true,
"auto_key": {
"ike_gateway": [
{
"name": "string"
}
],
"ipsec_crypto_profile": "string",
"proxy_id": [
{
"local": "string",
"name": "string",
"protocol": {
"number": 0
},
"remote": "string"
}
],
"proxy_id_v6": [
{
"local": "string",
"name": "string",
"protocol": {
"number": 0
},
"remote": "string"
}
]
},
"copy_tos": false,
"enable_gre_encapsulation": false,
"id": "abcd-1234",
"name": "string",
"tunnel_monitor": {
"destination_ip": "string",
"enable": true,
"proxy_id": "string"
}
}
],
"limit": 200,
"offset": 0,
"total": 0
}
Bad Request
- application/json
- Schema
- Example (from schema)
- input_format_mismatch
- invalid_query_parameter
- missing_query_parameter
- output_format_mismatch
Schema
_errors object[]
Array [code stringdetails objecthelp stringmessage string]- _request_id string
{
"_errors": [
{
"code": "string",
"details": {},
"help": "string",
"message": "string"
}
],
"_request_id": "string"
}
Input Format Mismatch
{
"_errors": [
{
"code": "E003",
"details": {},
"message": "Input Format Mismatch: input-format=json"
}
],
"_request_id": "abcd-1234"
}
Invalid Query Parameter
{
"_errors": [
{
"code": "E003",
"details": {},
"message": "Invalid Query Parameter: location=invalid"
}
],
"_request_id": "abcd-1234"
}
Missing Query Parameter
{
"_errors": [
{
"code": "E003",
"details": {},
"message": "Missing Query Parameter: name"
}
],
"_request_id": "abcd-1234"
}
Output Format Mismatch
{
"_errors": [
{
"code": "E003",
"details": {},
"message": "Output Format Mismatch: output-format=json Accept=xml"
}
],
"_request_id": "abcd-1234"
}
Unauthorized
- application/json
- Schema
- Example (from schema)
- auth_not_authenticated
- invalid_credential
- key_expired
- key_too_long
- need_password_change
Schema
_errors object[]
Array [code stringdetails objecthelp stringmessage string]- _request_id string
{
"_errors": [
{
"code": "string",
"details": {},
"help": "string",
"message": "string"
}
],
"_request_id": "string"
}
Not Authenticated
{
"_errors": [
{
"code": "E016",
"details": {},
"message": "Not Authenticated"
}
],
"_request_id": "abcd-1234"
}
Invalid Credential
{
"_errors": [
{
"code": "E016",
"details": {},
"message": "Invalid Credential"
}
],
"_request_id": "abcd-1234"
}
Key Expired
{
"_errors": [
{
"code": "E016",
"details": {},
"message": "Key Expired"
}
],
"_request_id": "abcd-1234"
}
Key Too Long
{
"_errors": [
{
"code": "E016",
"details": {},
"message": "Key Too Long"
}
],
"_request_id": "abcd-1234"
}
Need Password Change
{
"_errors": [
{
"code": "E016",
"details": {},
"message": "The password needs to be changed."
}
],
"_request_id": "abcd-1234"
}
Forbidden
- application/json
- Schema
- Example (from schema)
- auth_unauthorized
Schema
_errors object[]
Array [code stringdetails objecthelp stringmessage string]- _request_id string
{
"_errors": [
{
"code": "string",
"details": {},
"help": "string",
"message": "string"
}
],
"_request_id": "string"
}
Unauthorized
{
"_errors": [
{
"code": "E007",
"details": {},
"message": "Unauthorized"
}
],
"_request_id": "abcd-1234"
}
Not Found
- application/json
- Schema
- Example (from schema)
- object_not_present
Schema
_errors object[]
Array [code stringdetails objecthelp stringmessage string]- _request_id string
{
"_errors": [
{
"code": "string",
"details": {},
"help": "string",
"message": "string"
}
],
"_request_id": "string"
}
Object Not Present
{
"_errors": [
{
"code": "E005",
"details": {},
"message": "Object Not Present"
}
],
"_request_id": "abcd-1234"
}
General Errors
- application/json
- Schema
- Example (from schema)
- action_not_supported
- bad_xpath
- invalid_command
- malformed_command
- method_not_allowed
- session_timeout
- version_not_supported
Schema
_errors object[]
Array [code stringdetails objecthelp stringmessage string]- _request_id string
{
"_errors": [
{
"code": "string",
"details": {},
"help": "string",
"message": "string"
}
],
"_request_id": "string"
}
Action Not Supported
{
"_errors": [
{
"code": "E012",
"details": {},
"message": "Action Not Supported: move"
}
],
"_request_id": "abcd-1234"
}
Bad XPath
{
"_errors": [
{
"code": "E013",
"details": {},
"message": "Bad XPath"
}
],
"_request_id": "abcd-1234"
}
Invalid Command
{
"_errors": [
{
"code": "E003",
"details": {},
"message": "Invalid Command"
}
],
"_request_id": "abcd-1234"
}
Malformed Command
{
"_errors": [
{
"code": "E003",
"details": {},
"message": "Malformed Command"
}
],
"_request_id": "abcd-1234"
}
Method Not Supported
{
"_errors": [
{
"code": "E012",
"details": {},
"message": "Method Not Supported"
}
],
"_request_id": "abcd-1234"
}
Session Timeout
{
"_errors": [
{
"code": 4,
"details": {},
"message": "Session Timeout"
}
],
"_request_id": "abcd-1234"
}
Version Not Supported
{
"_errors": [
{
"code": "E012",
"details": {},
"message": "Version Not Supported"
}
],
"_request_id": "abcd-1234"
}