Palo Alto Networks Logical Routers API
Logical Routers
OpenAPI Specification
openapi: 3.2.0
info:
version: 2.0.0
title: Network Services Logical Routers API
description: These APIs are used for defining and managing network services configuration within Strata Cloud Manager.
termsOfService: https://www.paloaltonetworks.com/content/dam/pan/en_US/assets/pdf/legal/palo-alto-networks-end-user-license-agreement-eula.pdf
contact:
email: support@paloaltonetworks.com
name: Palo Alto Networks Technical Support
url: https://support.paloaltonetworks.com
license:
name: MIT
url: https://opensource.org/license/mit
servers:
- url: https://api.strata.paloaltonetworks.com/config/network/v1
description: Current
- url: https://api.sase.paloaltonetworks.com/sse/config/v1
description: Legacy
security:
- scmToken: []
tags:
- name: Logical Routers
description: Logical Routers
paths:
/logical-routers:
get:
tags:
- Logical Routers
summary: List logical routers
description: 'Retrieve a list of logical routers.
'
operationId: ListLogicalRouters
parameters:
- $ref: '#/components/parameters/pagination-optional'
- $ref: '#/components/parameters/limit'
- $ref: '#/components/parameters/offset'
- $ref: '#/components/parameters/name'
- $ref: '#/components/parameters/folder'
- $ref: '#/components/parameters/snippet'
- $ref: '#/components/parameters/device'
responses:
'200':
description: OK
content:
application/json:
schema:
type: object
properties:
data:
allOf:
- type: array
items:
$ref: '#/components/schemas/logical-routers'
limit:
type: integer
default: 200
offset:
type: integer
default: 0
total:
type: integer
'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'
post:
tags:
- Logical Routers
summary: Create a logical router
description: 'Create a new logical router.
'
operationId: CreateLogicalRouters
requestBody:
description: Created
content:
application/json:
schema:
$ref: '#/components/schemas/logical-routers'
responses:
'201':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/logical-routers'
'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'
/logical-routers/{id}:
get:
tags:
- Logical Routers
summary: Get a logical router
description: 'Get an existing logical router.
'
operationId: GetLogicalRoutersByID
parameters:
- $ref: '#/components/parameters/uuid'
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/logical-routers'
'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'
put:
tags:
- Logical Routers
summary: Update a logical router
description: 'Update an existing logical router.
'
operationId: UpdateLogicalRoutersByID
parameters:
- $ref: '#/components/parameters/uuid'
requestBody:
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/logical-routers'
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/logical-routers'
'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'
delete:
tags:
- Logical Routers
summary: Delete a logical router
description: 'Delete a logical router.
'
operationId: DeleteLogicalRoutersByID
parameters:
- $ref: '#/components/parameters/uuid'
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'
components:
examples:
json_401_panui_auth_key_expired:
summary: Key Expired
value:
_errors:
- code: E016
message: Key Expired
details: {}
_request_id: 123e4567-e89b-12d3-a456-426655440000
json_501_panui_restapi_method_not_supported:
summary: Method Not Supported
value:
_errors:
- code: E012
message: Method Not Supported
details: {}
_request_id: 123e4567-e89b-12d3-a456-426655440000
json_400_panui_restapi_input_format_mismatch:
summary: Input Format Mismatch
value:
_errors:
- code: E003
message: 'Input Format Mismatch: input-format=json'
details: {}
_request_id: 123e4567-e89b-12d3-a456-426655440000
json_501_panui_restapi_version_not_supported:
summary: Version Not Supported
value:
_errors:
- code: E012
message: Version Not Supported
details: {}
_request_id: 123e4567-e89b-12d3-a456-426655440000
json_409_panui_mgmt_name_not_unique:
summary: Name Not Unique
value:
_errors:
- code: E006
message: Name Not Unique
details: {}
_request_id: 123e4567-e89b-12d3-a456-426655440000
json_409_panui_mgmt_object_not_unique:
summary: Object Not Unique
value:
_errors:
- code: E016
message: Object Not Unique
details: {}
_request_id: 123e4567-e89b-12d3-a456-426655440000
json_400_panui_restapi_missing_body:
summary: Missing Body
value:
_errors:
- code: E003
message: Missing Body
details: {}
_request_id: 123e4567-e89b-12d3-a456-426655440000
json_404_panui_mgmt_object_not_present:
summary: Object Not Present
value:
_errors:
- code: E005
message: Object Not Present
details: {}
_request_id: 123e4567-e89b-12d3-a456-426655440000
json_409_panui_mgmt_reference_not_zero:
summary: Reference Not Zero
value:
_errors:
- code: E009
message: Reference Not Zero
details: {}
_request_id: 123e4567-e89b-12d3-a456-426655440000
json_400_panui_mgmt_invalid_command:
summary: Invalid Command
value:
_errors:
- code: E003
message: Invalid Command
details: {}
_request_id: 123e4567-e89b-12d3-a456-426655440000
json_400_panui_restapi_output_format_mismatch:
summary: Output Format Mismatch
value:
_errors:
- code: E003
message: 'Output Format Mismatch: output-format=json Accept=xml'
details: {}
_request_id: 123e4567-e89b-12d3-a456-426655440000
json_401_panui_auth_not_authenticated:
summary: Not Authenticated
value:
_errors:
- code: E016
message: Not Authenticated
details: {}
_request_id: 123e4567-e89b-12d3-a456-426655440000
json_401_panui_auth_invalid_credential:
summary: Invalid Credential
value:
_errors:
- code: E016
message: Invalid Credential
details: {}
_request_id: 123e4567-e89b-12d3-a456-426655440000
json_403_panui_auth_unauthorized:
summary: Unauthorized
value:
_errors:
- code: E007
message: Unauthorized
details: {}
_request_id: 123e4567-e89b-12d3-a456-426655440000
json_400_panui_restapi_missing_query_parameter:
summary: Missing Query Parameter
value:
_errors:
- code: E003
message: 'Missing Query Parameter: name'
details: {}
_request_id: 123e4567-e89b-12d3-a456-426655440000
json_405_panui_restapi_action_not_supported:
summary: Action Not Supported
value:
_errors:
- code: E012
message: 'Action Not Supported: move'
details: {}
_request_id: 123e4567-e89b-12d3-a456-426655440000
json_400_panui_restapi_invalid_query_parameter:
summary: Invalid Query Parameter
value:
_errors:
- code: E003
message: 'Invalid Query Parameter: location=invalid'
details: {}
_request_id: 123e4567-e89b-12d3-a456-426655440000
json_401_panui_auth_key_too_long:
summary: Key Too Long
value:
_errors:
- code: E016
message: Key Too Long
details: {}
_request_id: 123e4567-e89b-12d3-a456-426655440000
json_400_panui_mgmt_invalid_object:
summary: Invalid Object
value:
_errors:
- code: E003
message: Invalid Object
details: {}
_request_id: 123e4567-e89b-12d3-a456-426655440000
json_400_panui_mgmt_malformed_command:
summary: Malformed Command
value:
_errors:
- code: E003
message: Malformed Command
details: {}
_request_id: 123e4567-e89b-12d3-a456-426655440000
json_504_panui_mgmt_session_timeout:
summary: Session Timeout
value:
_errors:
- code: '4'
message: Session Timeout
details: {}
_request_id: 123e4567-e89b-12d3-a456-426655440000
json_401_panui_auth_need_password_change:
summary: Need Password Change
value:
_errors:
- code: E016
message: The password needs to be changed.
details: {}
_request_id: 123e4567-e89b-12d3-a456-426655440000
json_400_panui_mgmt_bad_xpath:
summary: Bad XPath
value:
_errors:
- code: E013
message: Bad XPath
details: {}
_request_id: 123e4567-e89b-12d3-a456-426655440000
parameters:
uuid:
name: id
in: path
description: The UUID of the configuration resource
required: true
schema:
type: string
format: uuid
example: 123e4567-e89b-12d3-a456-426655440000
pagination-optional:
name: pagination
in: query
required: false
schema:
type: boolean
description: The parameter to mention if the response should be paginated. By default, its set to false
name:
name: name
in: query
description: The name of the configuration resource
required: false
schema:
type: string
limit:
name: limit
in: query
description: The maximum number of results per page
required: false
schema:
type: integer
default: 200
folder:
name: folder
in: query
description: 'The folder in which the resource is defined
'
required: false
schema:
type: string
snippet:
name: snippet
in: query
description: 'The snippet in which the resource is defined
'
required: false
schema:
type: string
offset:
name: offset
in: query
description: The offset into the list of results returned
required: false
schema:
type: integer
default: 0
device:
name: device
in: query
description: 'The device in which the resource is defined
'
required: false
schema:
type: string
responses:
http_ok:
description: OK
not_found:
description: Not Found
content:
application/json:
schema:
$ref: '#/components/schemas/generic_error'
examples:
object_not_present:
$ref: '#/components/examples/json_404_panui_mgmt_object_not_present'
default_errors:
description: General Errors
content:
application/json:
schema:
$ref: '#/components/schemas/generic_error'
examples:
version_not_supported:
$ref: '#/components/examples/json_501_panui_restapi_version_not_supported'
method_not_allowed:
$ref: '#/components/examples/json_501_panui_restapi_method_not_supported'
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'
session_timeout:
$ref: '#/components/examples/json_504_panui_mgmt_session_timeout'
bad_request_errors_basic_with_body:
description: Bad Request
content:
application/json:
schema:
$ref: '#/components/schemas/generic_error'
examples:
input_format_mismatch:
$ref: '#/components/examples/json_400_panui_restapi_input_format_mismatch'
output_format_mismatch:
$ref: '#/components/examples/json_400_panui_restapi_output_format_mismatch'
missing_query_parameter:
$ref: '#/components/examples/json_400_panui_restapi_missing_query_parameter'
invalid_query_parameter:
$ref: '#/components/examples/json_400_panui_restapi_invalid_query_parameter'
missing_body:
$ref: '#/components/examples/json_400_panui_restapi_missing_body'
invalid_object:
$ref: '#/components/examples/json_400_panui_mgmt_invalid_object'
bad_request_errors_basic:
description: Bad Request
content:
application/json:
schema:
$ref: '#/components/schemas/generic_error'
examples:
input_format_mismatch:
$ref: '#/components/examples/json_400_panui_restapi_input_format_mismatch'
output_format_mismatch:
$ref: '#/components/examples/json_400_panui_restapi_output_format_mismatch'
missing_query_parameter:
$ref: '#/components/examples/json_400_panui_restapi_missing_query_parameter'
invalid_query_parameter:
$ref: '#/components/examples/json_400_panui_restapi_invalid_query_parameter'
auth_errors:
description: Unauthorized
content:
application/json:
schema:
$ref: '#/components/schemas/generic_error'
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_too_long:
$ref: '#/components/examples/json_401_panui_auth_key_too_long'
key_expired:
$ref: '#/components/examples/json_401_panui_auth_key_expired'
need_password_change:
$ref: '#/components/examples/json_401_panui_auth_need_password_change'
conflict_errors:
description: Conflict
content:
application/json:
schema:
$ref: '#/components/schemas/generic_error'
examples:
object_not_unique:
$ref: '#/components/examples/json_409_panui_mgmt_object_not_unique'
name_not_unique:
$ref: '#/components/examples/json_409_panui_mgmt_name_not_unique'
reference_not_zero:
$ref: '#/components/examples/json_409_panui_mgmt_reference_not_zero'
access_errors:
description: Forbidden
content:
application/json:
schema:
$ref: '#/components/schemas/generic_error'
examples:
auth_unauthorized:
$ref: '#/components/examples/json_403_panui_auth_unauthorized'
schemas:
generic_error:
type: object
properties:
_errors:
$ref: '#/components/schemas/error_detail_cause_infos'
_request_id:
type: string
x-examples: {}
error_detail_cause_info:
type: object
title: Cause Info
properties:
code:
type: string
message:
type: string
details:
oneOf:
- type: string
- type: object
help:
type: string
error_detail_cause_infos:
type: array
items:
$ref: '#/components/schemas/error_detail_cause_info'
x-examples: {}
logical-routers:
type: object
required:
- name
properties:
id:
type: string
description: UUID of the resource
readOnly: true
example: 123e4567-e89b-12d3-a456-426655440000
name:
type: string
routing_stack:
type: string
enum:
- legacy
- advanced
vrf:
type: array
items:
type: object
required:
- name
properties:
name:
type: string
interface:
type: array
items:
type: string
global_vrid:
type: integer
zone_name:
type: string
admin_dists:
type: object
properties:
static:
type: integer
static_ipv6:
type: integer
ospf_inter:
type: integer
ospf_intra:
type: integer
ospf_ext:
type: integer
ospfv3_inter:
type: integer
ospfv3_intra:
type: integer
ospfv3_ext:
type: integer
bgp_internal:
type: integer
bgp_external:
type: integer
bgp_local:
type: integer
rip:
type: integer
vr_admin_dists:
type: object
properties:
static:
type: integer
static_ipv6:
type: integer
ospf_int:
type: integer
ospf_ext:
type: integer
ospfv3_int:
type: integer
ospfv3_ext:
type: integer
ibgp:
type: integer
ebgp:
type: integer
rip:
type: integer
sdwan_type:
type: string
rib_filter:
type: object
properties:
ipv4:
type: object
properties:
static:
type: object
properties:
route_map:
type: string
bgp:
type: object
properties:
route_map:
type: string
ospf:
type: object
properties:
route_map:
type: string
rip:
type: object
properties:
route_map:
type: string
ipv6:
type: object
properties:
static:
type: object
properties:
route_map:
type: string
bgp:
type: object
properties:
route_map:
type: string
ospfv3:
type: object
properties:
route_map:
type: string
routing_table:
type: object
properties:
ip:
type: object
properties:
static_route:
type: array
items:
type: object
required:
- name
properties:
name:
type: string
destination:
type: string
interface:
type: string
nexthop:
type: object
oneOf:
- title: receive
required:
- receive
properties:
receive:
type: object
properties: {}
- title: discard
required:
- discard
properties:
discard:
type: object
properties: {}
- title: ip_address
required:
- ip_address
properties:
ip_address:
type: string
- title: ipv6_address
required:
- ipv6_address
properties:
ipv6_address:
type: string
- title: fqdn
required:
- fqdn
properties:
fqdn:
type: string
- title: next_lr
required:
- next_lr
properties:
next_lr:
type: string
- title: next_vr
required:
- next_vr
properties:
next_vr:
type: string
- title: tunnel
required:
- tunnel
properties:
tunnel:
type: string
route_table:
type: object
oneOf:
- title: unicast
required:
- unicast
properties:
unicast:
type: object
properties: {}
- title: multicast
required:
- multicast
properties:
multicast:
type: object
properties: {}
- title: both
required:
- both
properties:
both:
type: object
properties: {}
- title: no_install
required:
- no_install
properties:
no_install:
type: object
properties: {}
admin_dist:
type: integer
metric:
type: integer
bfd:
type: object
properties:
profile:
type: string
path_monitor:
type: object
properties:
enable:
type: boolean
failure_condition:
type: string
enum:
- any
- all
hold_time:
type: integer
monitor_destinations:
type: array
items:
type: object
required:
- name
properties:
name:
type: string
enable:
type: boolean
source:
type: string
destination:
type: string
destination_fqdn:
type: string
interval:
type: integer
count:
type: integer
ipv6:
type: object
properties:
static_route:
type: array
items:
type: object
required:
- name
properties:
name:
type: string
destination:
type: string
interface:
type: string
nexthop:
type: object
oneOf:
- title: receive
required:
- receive
properties:
receive:
type: object
properties: {}
- title: discard
required:
- discard
properties:
discard:
type: object
properties: {}
- title: ipv6_address
required:
- ipv6_address
properties:
ipv6_address:
type: string
- title: fqdn
required:
- fqdn
properties:
fqdn:
type: string
- title: next_lr
required:
- next_lr
properties:
next_lr:
type: string
- title: next_vr
required:
- next_vr
properties:
next_vr:
type: string
- title: tunnel
required:
- tunnel
properties:
tunnel:
type: string
admin_dist:
type: integer
metric:
type: integer
option:
type: object
properties:
passive:
type: object
properties: {}
route_table:
type: object
properties:
unicast:
type: object
properties: {}
multicast:
type: object
properties: {}
both:
type: object
properties: {}
no_install:
type: object
properties: {}
bfd:
type: object
properties:
profile:
type: string
path_monitor:
type: object
properties:
enable:
type: boole
# --- truncated at 32 KB (161 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/palo-alto-networks/refs/heads/main/openapi/palo-alto-networks-logical-routers-api-openapi.yml