Palo Alto Networks Infrastructure Settings API
Infrastructure Settings
Operations 7
Each operation below carries the questions people ask an LLM about it and the instructions they give an agent to run it. Generated by API Evangelist overlay
Infrastructure Settings
Each operation below carries the questions people ask an LLM about it and the instructions they give an agent to run it. Generated by API Evangelist overlay
Every API here is available over the APIs.io API and to AI agents over MCP.
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
find_apisBrowse and filter every API in the catalog.get_api_artifactsOne API's artifacts, grouped by type.get_openapiThe primary OpenAPI for this API.find_similar_apisAPIs that look like this one.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.curl "https://apis.io/api/v1/apis/palo-alto-networks:palo-alto-networks-infrastructure-settings-api"
curl "https://apis.io/api/v1/apis?limit=25"
Discovery needs no key. Ratings and market analysis are Pro.
Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.
openapi: 3.2.0
info:
version: 2.0.0
title: GlobalProtect Infrastructure Settings API
description: These APIs are used for defining and managing Prisma Access GlobalProtect services 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/mobile-agent/v1
description: Current
- url: https://api.sase.paloaltonetworks.com/sse/config/v1/mobile-agent
description: Legacy
security:
- scmToken: []
tags:
- name: Infrastructure Settings
description: Infrastructure Settings
paths:
/infrastructure-settings:
get:
tags:
- Infrastructure Settings
summary: List GlobalProtect infrastructure settings
description: Retrieve a list of GlobalProtect infrastructure settings
operationId: GetGlobalProtectInfrastructureSettings
parameters:
- $ref: '#/components/parameters/name-required'
- $ref: '#/components/parameters/folder-mobileusers-required'
responses:
'200':
description: OK
content:
application/json:
schema:
type: array
items:
type: array
items:
$ref: '#/components/schemas/mobile-agent-infrastructure-settings'
'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:
- Infrastructure Settings
summary: Create a GlobalProtect infrastructure setting
description: Create a new GlobalProtect infrastructure setting
operationId: CreateGlobalProtectInfrastructureSettings
parameters:
- $ref: '#/components/parameters/folder-mobileusers-required'
requestBody:
description: Created
content:
application/json:
schema:
$ref: '#/components/schemas/mobile-agent-infrastructure-settings'
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'
put:
tags:
- Infrastructure Settings
summary: Update a GlobalProtect infrastructure setting
description: Update an existing GlobalProtect infrastructure setting
operationId: UpdateGlobalProtectInfrastructureSettings
parameters:
- $ref: '#/components/parameters/folder-mobileusers-required'
requestBody:
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/mobile-agent-infrastructure-settings'
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'
delete:
tags:
- Infrastructure Settings
summary: Delete a GlobalProtect infrastructure setting
operationId: DeleteGlobalProtectInfrastructureSettings
parameters:
- $ref: '#/components/parameters/name-required'
- $ref: '#/components/parameters/folder-mobileusers-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'
/sse/config/v1/enable:
post:
description: 'Set up application defaults for a newly on-boarded tenant. This replaces the initialization
performed by the Prisma Access Cloud-Managed user interface when a tenant is initially
created.
Use this API after you have created a tenant and claimed
your Prisma Access license for that tenant.'
operationId: post-sse-config-v1-enable
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: Set up application defaults
tags:
- Infrastructure Settings
/sse/config/v1/shared-infrastructure-settings:
get:
description: List all infrastructure settings.
operationId: get-sse-config-v1-shared-infrastructure-settings
parameters:
- $ref: '#/components/parameters/limit-optional'
- $ref: '#/components/parameters/offset-optional'
responses:
'200':
content:
application/json:
schema:
properties:
data:
allOf:
- items:
$ref: '#/components/schemas/shared-infrastructure-settings'
type: array
limit:
default: 200
type: number
offset:
default: 0
type: number
total:
type: number
type: object
description: List of infrastructure settings under Shared folder
'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 all infrastructure settings
tags:
- Infrastructure Settings
put:
description: Edit an infrastructure setting.
operationId: put-sse-config-v1-shared-infrastructure-settings
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/edit-shared-infrastructure-settings'
description: The infrastructure settings 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 an infrastructure setting
tags:
- Infrastructure Settings
components:
examples:
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_401_panui_auth_not_authenticated:
summary: Not Authenticated
value:
_errors:
- code: E016
message: Not Authenticated
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_403_panui_auth_unauthorized:
summary: Unauthorized
value:
_errors:
- code: E007
message: Unauthorized
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_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_401_panui_auth_invalid_credential:
summary: Invalid Credential
value:
_errors:
- code: E016
message: Invalid Credential
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_401_panui_auth_key_expired:
summary: Key Expired
value:
_errors:
- code: E016
message: Key Expired
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_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_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_400_panui_mgmt_invalid_command:
summary: Invalid Command
value:
_errors:
- code: E003
message: Invalid Command
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_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_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_504_panui_mgmt_session_timeout:
summary: Session Timeout
value:
_errors:
- code: '4'
message: Session Timeout
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
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_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_missing_body:
summary: Missing Body
value:
_errors:
- code: E003
message: Missing Body
details: {}
_request_id: 123e4567-e89b-12d3-a456-426655440000
responses:
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'
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'
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'
http_created:
description: Created
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'
schemas:
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
static-ip-pool:
type: object
properties:
name:
type: string
maxLength: 128
description: Name of the static-ip-pool entry. Alphanumeric string [0-9a-zA-Z._-]
pool_type:
type: string
enum:
- Static-IP
ip_pool:
type: array
items:
type: string
format: cidr
description: IP subnets
theatres:
type: array
items:
type: string
description: IP pools on theatres
users:
type: array
items:
type: string
description: IP pools on users
user_groups:
type: array
items:
type: object
properties:
name:
type: string
maxLength: 320
description: Distinguished Name of the group
directory:
type: string
description: IP pools on user groups
location_groups:
type: array
items:
type: string
description: IP pools on location groups
devices:
type: string
enum:
- Any
description: IP pools on device groups
lease_period:
type: integer
minimum: 0
maximum: 7776000
description: Lease period in seconds
grace_period:
type: integer
minimum: 0
maximum: 7776000
description: Grace period in seconds
required:
- name
- ip_pool
generic_error:
type: object
properties:
_errors:
$ref: '#/components/schemas/error_detail_cause_infos'
_request_id:
type: string
x-examples: {}
error_detail_cause_infos:
type: array
items:
$ref: '#/components/schemas/error_detail_cause_info'
x-examples: {}
mobile-agent-infrastructure-settings:
type: object
properties:
id:
type: string
description: UUID of the resource
readOnly: true
example: 123e4567-e89b-12d3-a456-426655440000
name:
type: string
dns_servers:
type: array
items:
type: object
properties:
name:
type: string
dns_suffix:
type: array
items:
type: string
internal_dns_match:
type: array
items:
type: object
properties:
name:
type: string
domain_list:
type: array
items:
type: string
primary:
type: object
properties:
dns_server:
type: object
use_cloud_default:
type: object
secondary:
type: object
properties:
dns_server:
type: object
use_cloud_default:
type: object
primary_public_dns:
type: object
properties:
dns_server:
type: string
secondary_public_dns:
type: object
properties:
dns_server:
type: string
enable_wins:
type: object
properties:
'no':
type: object
'yes':
type: object
properties:
wins_servers:
type: array
items:
type: object
properties:
name:
type: string
primary:
type: string
secondary:
type: string
ip_pools:
type: array
items:
type: object
properties:
name:
type: string
ip_pool:
type: array
items:
type: string
ipv6:
type: boolean
portal_hostname:
type: object
properties:
custom_domain:
type: object
properties:
cname:
type: string
hostname:
type: string
ssl_tls_service_profile:
type: string
description: value is muCustomDomainSSLProfile, it will reference to the corresponding certificate under ssl-tls-service-profile automatically
default: muCustomDomainSSLProfile
default_domain:
type: object
properties:
hostname:
type: string
udp_queries:
type: object
properties:
retries:
type: object
properties:
attempts:
type: number
description: Maximum number of retries before trying next name server
minimum: 1
maximum: 30
interval:
type: number
description: Time in seconds for another request to be sent
minimum: 1
maximum: 30
static_ip_pools:
type: array
items:
$ref: '#/components/schemas/static-ip-pool'
required:
- id
- name
- dns_servers
- ip_pools
- portal_hostname
edit-shared-infrastructure-settings:
properties:
egress_ip_notification_url:
type: string
infra_bgp_as:
type: string
infrastructure_subnet:
type: string
infrastructure_subnet_ipv6:
type: string
type: object
shared-infrastructure-settings:
properties:
api_key:
type: string
captive_portal_redirect_ip_address:
type: string
egress_ip_notification_url:
type: string
infra_bgp_as:
type: string
infrastructure_subnet:
type: string
infrastructure_subnet_ipv6:
type: string
ipv6:
type: boolean
loopback_ips:
items:
type: string
type: array
tunnel_monitor_ip_address:
type: string
type: object
parameters:
folder-mobileusers-required:
name: folder
in: query
description: 'The folder in which the resource is defined
'
schema:
enum:
- Mobile Users
name-required:
name: name
in: query
description: The name of the configuration resource
required: true
schema:
type: string
offset-optional:
description: 'The offset of the result entry.
'
in: query
name: offset
required: false
schema:
type: number
limit-optional:
description: 'The maximum number of result objects to return per page.
'
in: query
name: limit
required: false
schema:
type: number
securitySchemes:
scmOAuth:
type: oauth2
description: "Strata Cloud Manager APIs authenticate client requests using the \nOAuth 2.0 Client Credentials flow. Please use the `client_id`, \n`client_secret` values associated with an IAM service account along \nwith a scope value of `tsg_id:XXXXXXXXXX`, where `XXXXXXXXXX` is the \nTenant Service Group (TSG) ID. The resulting JWT access token should \nbe attached to all API calls as a `Bearer` token in the `Authorization` \nheader (ex. `Authorization: Bearer tokenstring`).\n"
flows:
clientCredentials:
tokenUrl: https://auth.apps.paloaltonetworks.com/oauth2/access_token
scopes: {}
scmToken:
type: http
description: "Strata Cloud Manager APIs authenticate client requests using the \nOAuth 2.0 Client Credentials flow. Please use the `client_id`, \n`client_secret` values associated with an IAM service account along \nwith a scope value of `tsg_id:XXXXXXXXXX`, where `XXXXXXXXXX` is the \nTenant Service Group (TSG) ID. The resulting JWT access token should \nbe attached to all API calls as a `Bearer` token in the `Authorization` \nheader (ex. `Authorization: Bearer tokenstring`).\n"
scheme: bearer
bearerFormat: JWT
Bearer:
scheme: bearer
type: http
x-internal: false