Palo Alto Networks IKE Gateways API
The IKEGateways API from Palo Alto Networks — 2 operation(s) for ikegateways.
OpenAPI Specification
openapi: 3.2.0
info:
contact: {}
description: 'Manages Internet Key Exchange (IKE) Gateway network profiles, which specify
the configuration information necessary to perform IKE protocol negotiation with a
peer gateway. This is the Phase 1 portion of the IKE/IPSec VPN setup.
'
title: IKE Gateway Management IKE Gateways API
version: '1.0'
x-logo:
url: pan-logo.png
servers:
- url: https://api.sase.paloaltonetworks.com
tags:
- name: IKEGateways
paths:
/sse/config/v1/ike-gateways:
get:
description: Retrieve IKE gateway.
operationId: get-sse-config-v1-ike-gateways
parameters:
- $ref: '#/components/parameters/limit-optional'
- $ref: '#/components/parameters/offset-optional'
- $ref: '#/components/parameters/name-optional'
- $ref: '#/components/parameters/folder'
responses:
'200':
content:
application/json:
schema:
properties:
data:
allOf:
- items:
$ref: '#/components/schemas/ike-gateways'
type: array
limit:
default: 200
type: number
offset:
default: 0
type: number
total:
type: number
type: object
description: List of ike gateways
'400':
$ref: '#/components/responses/bad_request_errors_basic'
'401':
$ref: '#/components/responses/auth_errors'
'403':
$ref: '#/components/responses/access_errors'
'404':
$ref: '#/components/responses/not_found'
default:
$ref: '#/components/responses/default_errors'
security:
- Bearer: []
summary: List IKE gateways
tags:
- IKEGateways
post:
description: Create an IKE gateway.
operationId: post-sse-config-v1-ike-gateways
parameters:
- $ref: '#/components/parameters/folder'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ike-gateways'
description: The ike gateway you want to create
responses:
'201':
$ref: '#/components/responses/http_created'
'400':
$ref: '#/components/responses/bad_request_errors_basic_with_body'
'401':
$ref: '#/components/responses/auth_errors'
'403':
$ref: '#/components/responses/access_errors'
'409':
$ref: '#/components/responses/conflict_errors'
default:
$ref: '#/components/responses/default_errors'
security:
- Bearer: []
summary: Create IKE gateways
tags:
- IKEGateways
/sse/config/v1/ike-gateways/{id}:
delete:
description: 'Delete a ike gateway.
'
operationId: delete-sse-config-v1-ike-gateways-id
parameters:
- $ref: '#/components/parameters/uuid-required'
responses:
'200':
$ref: '#/components/responses/http_ok'
'400':
$ref: '#/components/responses/bad_request_errors_basic'
'401':
$ref: '#/components/responses/auth_errors'
'403':
$ref: '#/components/responses/access_errors'
'404':
$ref: '#/components/responses/not_found'
'409':
$ref: '#/components/responses/conflict_errors'
default:
$ref: '#/components/responses/default_errors'
security:
- Bearer: []
summary: Delete a ike gateway.
tags:
- IKEGateways
get:
description: Get an IKE gateway.
operationId: get-sse-config-v1-ike-gateways-id
parameters:
- $ref: '#/components/parameters/folder'
- $ref: '#/components/parameters/uuid-required'
responses:
'200':
content:
application/json:
schema:
allOf:
- items:
$ref: '#/components/schemas/ike-gateways'
type: array
description: Get the ike gateway by id.
'400':
$ref: '#/components/responses/bad_request_errors_basic'
'401':
$ref: '#/components/responses/auth_errors'
'403':
$ref: '#/components/responses/access_errors'
'404':
$ref: '#/components/responses/not_found'
default:
$ref: '#/components/responses/default_errors'
security:
- Bearer: []
summary: Get an IKE gateway
tags:
- IKEGateways
put:
description: 'Modify a ike gateway.
'
operationId: put-sse-config-v1-ike-gateways-id
parameters:
- $ref: '#/components/parameters/uuid-required'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ike-gateways'
description: The ike gateway you want to edit
responses:
'200':
$ref: '#/components/responses/http_ok'
'400':
$ref: '#/components/responses/bad_request_errors_basic_with_body'
'401':
$ref: '#/components/responses/auth_errors'
'403':
$ref: '#/components/responses/access_errors'
'404':
$ref: '#/components/responses/not_found'
'409':
$ref: '#/components/responses/conflict_errors'
default:
$ref: '#/components/responses/default_errors'
security:
- Bearer: []
summary: Edit a ike gateway.
tags:
- IKEGateways
components:
examples:
json_401_panui_auth_key_expired:
summary: Key Expired
value:
_errors:
- code: E016
details: {}
message: Key Expired
_request_id: abcd-1234
json_501_panui_restapi_method_not_supported:
summary: Method Not Supported
value:
_errors:
- code: E012
details: {}
message: Method Not Supported
_request_id: abcd-1234
json_400_panui_restapi_input_format_mismatch:
summary: Input Format Mismatch
value:
_errors:
- code: E003
details: {}
message: 'Input Format Mismatch: input-format=json'
_request_id: abcd-1234
json_501_panui_restapi_version_not_supported:
summary: Version Not Supported
value:
_errors:
- code: E012
details: {}
message: Version Not Supported
_request_id: abcd-1234
json_409_panui_mgmt_name_not_unique:
summary: Name Not Unique
value:
_errors:
- code: E006
details: {}
message: Name Not Unique
_request_id: abcd-1234
json_409_panui_mgmt_object_not_unique:
summary: Object Not Unique
value:
_errors:
- code: E016
details: {}
message: Object Not Unique
_request_id: abcd-1234
json_404_panui_mgmt_object_not_present:
summary: Object Not Present
value:
_errors:
- code: E005
details: {}
message: Object Not Present
_request_id: abcd-1234
json_400_panui_restapi_missing_body:
summary: Missing Body
value:
_errors:
- code: E003
details: {}
message: Missing Body
_request_id: abcd-1234
json_409_panui_mgmt_reference_not_zero:
summary: Reference Not Zero
value:
_errors:
- code: E009
details: {}
message: Reference Not Zero
_request_id: abcd-1234
json_400_panui_mgmt_invalid_command:
summary: Invalid Command
value:
_errors:
- code: E003
details: {}
message: Invalid Command
_request_id: abcd-1234
json_400_panui_restapi_output_format_mismatch:
summary: Output Format Mismatch
value:
_errors:
- code: E003
details: {}
message: 'Output Format Mismatch: output-format=json Accept=xml'
_request_id: abcd-1234
json_401_panui_auth_not_authenticated:
summary: Not Authenticated
value:
_errors:
- code: E016
details: {}
message: Not Authenticated
_request_id: abcd-1234
json_401_panui_auth_invalid_credential:
summary: Invalid Credential
value:
_errors:
- code: E016
details: {}
message: Invalid Credential
_request_id: abcd-1234
json_403_panui_auth_unauthorized:
summary: Unauthorized
value:
_errors:
- code: E007
details: {}
message: Unauthorized
_request_id: abcd-1234
json_400_panui_restapi_missing_query_parameter:
summary: Missing Query Parameter
value:
_errors:
- code: E003
details: {}
message: 'Missing Query Parameter: name'
_request_id: abcd-1234
json_405_panui_restapi_action_not_supported:
summary: Action Not Supported
value:
_errors:
- code: E012
details: {}
message: 'Action Not Supported: move'
_request_id: abcd-1234
json_400_panui_restapi_invalid_query_parameter:
summary: Invalid Query Parameter
value:
_errors:
- code: E003
details: {}
message: 'Invalid Query Parameter: location=invalid'
_request_id: abcd-1234
json_401_panui_auth_key_too_long:
summary: Key Too Long
value:
_errors:
- code: E016
details: {}
message: Key Too Long
_request_id: abcd-1234
json_400_panui_mgmt_invalid_object:
summary: Invalid Object
value:
_errors:
- code: E003
details: {}
message: Invalid Object
_request_id: abcd-1234
json_400_panui_mgmt_malformed_command:
summary: Malformed Command
value:
_errors:
- code: E003
details: {}
message: Malformed Command
_request_id: abcd-1234
json_504_panui_mgmt_session_timeout:
summary: Session Timeout
value:
_errors:
- code: 4
details: {}
message: Session Timeout
_request_id: abcd-1234
json_401_panui_auth_need_password_change:
summary: Need Password Change
value:
_errors:
- code: E016
details: {}
message: The password needs to be changed.
_request_id: abcd-1234
json_400_panui_mgmt_bad_xpath:
summary: Bad XPath
value:
_errors:
- code: E013
details: {}
message: Bad XPath
_request_id: abcd-1234
schemas:
ike-gateways:
properties:
authentication:
oneOf:
- properties:
pre_shared_key:
properties:
key:
type: string
type: object
title: pre_shared_key
type: object
- properties:
certificate:
properties:
allow_id_payload_mismatch:
type: boolean
certificate_profile:
type: string
local_certificate:
properties:
local_certificate_name:
type: string
type: object
strict_validation_revocation:
type: boolean
use_management_as_source:
type: boolean
type: object
title: certificate
type: object
type: object
id:
description: uuid of the resource
example: abcd-1234
readOnly: true
type: string
local_id:
properties:
id:
description: Local ID string
maxLength: 1024
minLength: 1
pattern: ^(.+\@[a-zA-Z0-9.-]+)$|^([$a-zA-Z0-9_:.-]+)$|^(([[:xdigit:]][[:xdigit:]])+)$|^([a-zA-Z0-9.]+=(\\,|[^,])+[, ]+)*([a-zA-Z0-9.]+=(\\,|[^,])+)$
type: string
type:
type: string
type: object
name:
description: 'Alphanumeric string begin with letter: [0-9a-zA-Z._-]'
maxLength: 63
type: string
peer_address:
oneOf:
- properties:
ip:
description: peer gateway has static IP address
type: string
title: ip
type: object
- properties:
fqdn:
description: peer gateway FQDN name
maxLength: 255
type: string
title: fqdn
type: object
- properties:
dynamic:
default: {}
type: object
title: dynamic
type: object
type: object
peer_id:
properties:
id:
description: Peer ID string
maxLength: 1024
minLength: 1
pattern: ^(.+\@[\*a-zA-Z0-9.-]+)$|^([\*$a-zA-Z0-9_:.-]+)$|^(([[:xdigit:]][[:xdigit:]])+)$|^([a-zA-Z0-9.]+=(\\,|[^,])+[, ]+)*([a-zA-Z0-9.]+=(\\,|[^,])+)$
type: string
type:
enum:
- ipaddr
- keyid
- fqdn
- ufqdn
type: string
type: object
protocol:
properties:
ikev1:
properties:
dpd:
properties:
enable:
type: boolean
type: object
ike_crypto_profile:
type: string
type: object
ikev2:
properties:
dpd:
properties:
enable:
type: boolean
type: object
ike_crypto_profile:
type: string
type: object
version:
default: ikev2-preferred
enum:
- ikev2-preferred
- ikev1
- ikev2
type: string
type: object
protocol_common:
properties:
fragmentation:
properties:
enable:
default: false
enum:
- false
type: boolean
type: object
nat_traversal:
properties:
enable:
type: boolean
type: object
passive_mode:
type: boolean
type: object
required:
- name
- authentication
- protocol
- peer_address
type: object
generic_error:
properties:
_errors:
$ref: '#/components/schemas/error_detail_cause_infos'
_request_id:
type: string
type: object
error_detail_cause_info:
properties:
code:
type: string
details:
type: object
help:
type: string
message:
type: string
title: Cause Info
type: object
error_detail_cause_infos:
items:
$ref: '#/components/schemas/error_detail_cause_info'
type: array
responses:
http_ok:
description: Ok
not_found:
content:
application/json:
examples:
object_not_present:
$ref: '#/components/examples/json_404_panui_mgmt_object_not_present'
schema:
$ref: '#/components/schemas/generic_error'
description: Not Found
default_errors:
content:
application/json:
examples:
action_not_supported:
$ref: '#/components/examples/json_405_panui_restapi_action_not_supported'
bad_xpath:
$ref: '#/components/examples/json_400_panui_mgmt_bad_xpath'
invalid_command:
$ref: '#/components/examples/json_400_panui_mgmt_invalid_command'
malformed_command:
$ref: '#/components/examples/json_400_panui_mgmt_malformed_command'
method_not_allowed:
$ref: '#/components/examples/json_501_panui_restapi_method_not_supported'
session_timeout:
$ref: '#/components/examples/json_504_panui_mgmt_session_timeout'
version_not_supported:
$ref: '#/components/examples/json_501_panui_restapi_version_not_supported'
schema:
$ref: '#/components/schemas/generic_error'
description: General Errors
bad_request_errors_basic_with_body:
content:
application/json:
examples:
input_format_mismatch:
$ref: '#/components/examples/json_400_panui_restapi_input_format_mismatch'
invalid_object:
$ref: '#/components/examples/json_400_panui_mgmt_invalid_object'
invalid_query_parameter:
$ref: '#/components/examples/json_400_panui_restapi_invalid_query_parameter'
missing_body:
$ref: '#/components/examples/json_400_panui_restapi_missing_body'
missing_query_parameter:
$ref: '#/components/examples/json_400_panui_restapi_missing_query_parameter'
output_format_mismatch:
$ref: '#/components/examples/json_400_panui_restapi_output_format_mismatch'
schema:
$ref: '#/components/schemas/generic_error'
description: Bad Request
bad_request_errors_basic:
content:
application/json:
examples:
input_format_mismatch:
$ref: '#/components/examples/json_400_panui_restapi_input_format_mismatch'
invalid_query_parameter:
$ref: '#/components/examples/json_400_panui_restapi_invalid_query_parameter'
missing_query_parameter:
$ref: '#/components/examples/json_400_panui_restapi_missing_query_parameter'
output_format_mismatch:
$ref: '#/components/examples/json_400_panui_restapi_output_format_mismatch'
schema:
$ref: '#/components/schemas/generic_error'
description: Bad Request
auth_errors:
content:
application/json:
examples:
auth_not_authenticated:
$ref: '#/components/examples/json_401_panui_auth_not_authenticated'
invalid_credential:
$ref: '#/components/examples/json_401_panui_auth_invalid_credential'
key_expired:
$ref: '#/components/examples/json_401_panui_auth_key_expired'
key_too_long:
$ref: '#/components/examples/json_401_panui_auth_key_too_long'
need_password_change:
$ref: '#/components/examples/json_401_panui_auth_need_password_change'
schema:
$ref: '#/components/schemas/generic_error'
description: Unauthorized
http_created:
description: Created
conflict_errors:
content:
application/json:
examples:
name_not_unique:
$ref: '#/components/examples/json_409_panui_mgmt_name_not_unique'
object_not_unique:
$ref: '#/components/examples/json_409_panui_mgmt_object_not_unique'
reference_not_zero:
$ref: '#/components/examples/json_409_panui_mgmt_reference_not_zero'
schema:
$ref: '#/components/schemas/generic_error'
description: Conflict
access_errors:
content:
application/json:
examples:
auth_unauthorized:
$ref: '#/components/examples/json_403_panui_auth_unauthorized'
schema:
$ref: '#/components/schemas/generic_error'
description: Forbidden
parameters:
uuid-required:
description: 'The resource''s unique identifier.
'
in: path
name: id
required: true
schema:
type: string
offset-optional:
description: 'The offset of the result entry.
'
in: query
name: offset
required: false
schema:
type: number
folder:
description: 'The folder on which you want to perform this operation.
'
in: query
name: folder
required: true
schema:
enum:
- Shared
- Mobile Users
- Remote Networks
- Service Connections
- Mobile Users Container
- Mobile Users Explicit Proxy
pattern: ^[0-9a-zA-Z._-\s]{1,}$
type: string
limit-optional:
description: 'The maximum number of result objects to return per page.
'
in: query
name: limit
required: false
schema:
type: number
name-optional:
description: 'The name of the entry.
'
in: query
name: name
required: false
schema:
type: string
securitySchemes:
Bearer:
scheme: bearer
type: http