Get an IKE gateway
Get an IKE gateway.
Path Parameters
- id string required
The resource's unique identifier.
Query Parameters
- 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
Get the ike gateway by id.
- application/json
- Schema
- Example (from schema)
Schema
- Array [
authentication object required
- oneOf
- pre_shared_key
- certificate
pre_shared_key object
key stringcertificate object
allow_id_payload_mismatch booleancertificate_profile stringlocal_certificate object
local_certificate_name stringstrict_validation_revocation booleanuse_management_as_source boolean- oneOf
- id string
uuid of the resource
local_id object
id stringPossible values:
non-empty
and<= 1024 characters
, Value must match regular expression^(.+\@[a-zA-Z0-9.-]+)$|^([$a-zA-Z0-9_:.-]+)$|^(([[:xdigit:]][[:xdigit:]])+)$|^([a-zA-Z0-9.]+=(\\,|[^,])+[, ]+)*([a-zA-Z0-9.]+=(\\,|[^,])+)$
Local ID string
type string- name string required
Possible values:
<= 63 characters
Alphanumeric string begin with letter: [0-9a-zA-Z._-]
peer_address object required
- oneOf
- ip
- fqdn
- dynamic
ip stringpeer gateway has static IP address
fqdn stringPossible values:
<= 255 characters
peer gateway FQDN name
dynamic objectDefault value:
[object Object]
- oneOf
peer_id object
id stringPossible values:
non-empty
and<= 1024 characters
, Value must match regular expression^(.+\@[\*a-zA-Z0-9.-]+)$|^([\*$a-zA-Z0-9_:.-]+)$|^(([[:xdigit:]][[:xdigit:]])+)$|^([a-zA-Z0-9.]+=(\\,|[^,])+[, ]+)*([a-zA-Z0-9.]+=(\\,|[^,])+)$
Peer ID string
type stringPossible values: [
ipaddr
,keyid
,fqdn
,ufqdn
]protocol object required
ikev1 object
dpd object
enable booleanike_crypto_profile stringikev2 object
dpd object
enable booleanike_crypto_profile stringversion stringPossible values: [
ikev2-preferred
,ikev1
,ikev2
]Default value:
ikev2-preferred
protocol_common object
fragmentation object
enable booleanPossible values: [
false
]Default value:
false
nat_traversal object
enable booleanpassive_mode boolean- ]
[
{
"authentication": {
"pre_shared_key": {
"key": "string"
}
},
"id": "abcd-1234",
"local_id": {
"id": "string",
"type": "string"
},
"name": "string",
"peer_address": {
"ip": "string"
},
"peer_id": {
"id": "string",
"type": "ipaddr"
},
"protocol": {
"ikev1": {
"dpd": {
"enable": true
},
"ike_crypto_profile": "string"
},
"ikev2": {
"dpd": {
"enable": true
},
"ike_crypto_profile": "string"
},
"version": "ikev2-preferred"
},
"protocol_common": {
"fragmentation": {
"enable": false
},
"nat_traversal": {
"enable": true
},
"passive_mode": true
}
}
]
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"
}