Create an IKE gateway
POST/ike-gateways
Create a new IKE gateway.
Request
- application/json
Body
Created
- folder
- snippet
- device
- pre_shared_key
- certificate
- ip
- fqdn
- dynamic
Possible values: <= 64 characters
, Value must match regular expression ^[a-zA-Z\d-_\. ]+$
The folder in which the resource is defined
Possible values: <= 64 characters
, Value must match regular expression ^[a-zA-Z\d-_\. ]+$
The snippet in which the resource is defined
Possible values: <= 64 characters
, Value must match regular expression ^[a-zA-Z\d-_\. ]+$
The device in which the resource is defined
Possible values: <= 63 characters
Alphanumeric string begin with letter: [0-9a-zA-Z._-]
authentication object required
pre_shared_key object
certificate object
local_certificate object
peer_id object
Possible values: [ipaddr
, keyid
, fqdn
, ufqdn
]
Possible 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
local_id object
Possible 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
protocol objectrequired
ikev1 object
dpd object
ikev2 object
dpd object
Possible values: [ikev2-preferred
, ikev1
, ikev2
]
Default value: ikev2-preferred
protocol_common object
nat_traversal object
fragmentation object
Possible values: [false
]
peer_address object required
peer gateway has static IP address
Possible values: <= 255 characters
peer gateway FQDN name
Default value: [object Object]
Responses
- 201
- 400
- 401
- 403
- 409
- default
Created
Bad Request
- application/json
- Schema
- Example (from schema)
- input_format_mismatch
- output_format_mismatch
- missing_query_parameter
- invalid_query_parameter
- missing_body
- invalid_object
Schema
- Array [
- ]
_errors object[]
{
"_errors": [
{
"code": "string",
"message": "string",
"details": {},
"help": "string"
}
],
"_request_id": "string"
}
{
"_errors": [
{
"code": "E003",
"message": "Input Format Mismatch: input-format=json",
"details": {}
}
],
"_request_id": "123e4567-e89b-12d3-a456-426655440000"
}
{
"_errors": [
{
"code": "E003",
"message": "Output Format Mismatch: output-format=json Accept=xml",
"details": {}
}
],
"_request_id": "123e4567-e89b-12d3-a456-426655440000"
}
{
"_errors": [
{
"code": "E003",
"message": "Missing Query Parameter: name",
"details": {}
}
],
"_request_id": "123e4567-e89b-12d3-a456-426655440000"
}
{
"_errors": [
{
"code": "E003",
"message": "Invalid Query Parameter: location=invalid",
"details": {}
}
],
"_request_id": "123e4567-e89b-12d3-a456-426655440000"
}
{
"_errors": [
{
"code": "E003",
"message": "Missing Body",
"details": {}
}
],
"_request_id": "123e4567-e89b-12d3-a456-426655440000"
}
{
"_errors": [
{
"code": "E003",
"message": "Invalid Object",
"details": {}
}
],
"_request_id": "123e4567-e89b-12d3-a456-426655440000"
}
Unauthorized
- application/json
- Schema
- Example (from schema)
- auth_not_authenticated
- invalid_credential
- key_too_long
- key_expired
- need_password_change
Schema
- Array [
- ]
_errors object[]
{
"_errors": [
{
"code": "string",
"message": "string",
"details": {},
"help": "string"
}
],
"_request_id": "string"
}
{
"_errors": [
{
"code": "E016",
"message": "Not Authenticated",
"details": {}
}
],
"_request_id": "123e4567-e89b-12d3-a456-426655440000"
}
{
"_errors": [
{
"code": "E016",
"message": "Invalid Credential",
"details": {}
}
],
"_request_id": "123e4567-e89b-12d3-a456-426655440000"
}
{
"_errors": [
{
"code": "E016",
"message": "Key Too Long",
"details": {}
}
],
"_request_id": "123e4567-e89b-12d3-a456-426655440000"
}
{
"_errors": [
{
"code": "E016",
"message": "Key Expired",
"details": {}
}
],
"_request_id": "123e4567-e89b-12d3-a456-426655440000"
}
{
"_errors": [
{
"code": "E016",
"message": "The password needs to be changed.",
"details": {}
}
],
"_request_id": "123e4567-e89b-12d3-a456-426655440000"
}
Forbidden
- application/json
- Schema
- Example (from schema)
- auth_unauthorized
Schema
- Array [
- ]
_errors object[]
{
"_errors": [
{
"code": "string",
"message": "string",
"details": {},
"help": "string"
}
],
"_request_id": "string"
}
{
"_errors": [
{
"code": "E007",
"message": "Unauthorized",
"details": {}
}
],
"_request_id": "123e4567-e89b-12d3-a456-426655440000"
}
Conflict
- application/json
- Schema
- Example (from schema)
- object_not_unique
- name_not_unique
- reference_not_zero
Schema
- Array [
- ]
_errors object[]
{
"_errors": [
{
"code": "string",
"message": "string",
"details": {},
"help": "string"
}
],
"_request_id": "string"
}
{
"_errors": [
{
"code": "E016",
"message": "Object Not Unique",
"details": {}
}
],
"_request_id": "123e4567-e89b-12d3-a456-426655440000"
}
{
"_errors": [
{
"code": "E006",
"message": "Name Not Unique",
"details": {}
}
],
"_request_id": "123e4567-e89b-12d3-a456-426655440000"
}
{
"_errors": [
{
"code": "E009",
"message": "Reference Not Zero",
"details": {}
}
],
"_request_id": "123e4567-e89b-12d3-a456-426655440000"
}
General Errors
- application/json
- Schema
- Example (from schema)
- version_not_supported
- method_not_allowed
- action_not_supported
- bad_xpath
- invalid_command
- malformed_command
- session_timeout
Schema
- Array [
- ]
_errors object[]
{
"_errors": [
{
"code": "string",
"message": "string",
"details": {},
"help": "string"
}
],
"_request_id": "string"
}
{
"_errors": [
{
"code": "E012",
"message": "Version Not Supported",
"details": {}
}
],
"_request_id": "123e4567-e89b-12d3-a456-426655440000"
}
{
"_errors": [
{
"code": "E012",
"message": "Method Not Supported",
"details": {}
}
],
"_request_id": "123e4567-e89b-12d3-a456-426655440000"
}
{
"_errors": [
{
"code": "E012",
"message": "Action Not Supported: move",
"details": {}
}
],
"_request_id": "123e4567-e89b-12d3-a456-426655440000"
}
{
"_errors": [
{
"code": "E013",
"message": "Bad XPath",
"details": {}
}
],
"_request_id": "123e4567-e89b-12d3-a456-426655440000"
}
{
"_errors": [
{
"code": "E003",
"message": "Invalid Command",
"details": {}
}
],
"_request_id": "123e4567-e89b-12d3-a456-426655440000"
}
{
"_errors": [
{
"code": "E003",
"message": "Malformed Command",
"details": {}
}
],
"_request_id": "123e4567-e89b-12d3-a456-426655440000"
}
{
"_errors": [
{
"code": "4",
"message": "Session Timeout",
"details": {}
}
],
"_request_id": "123e4567-e89b-12d3-a456-426655440000"
}