How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Need help?

Contact us
Palo Alto Networks

Palo Alto Networks Settings API

{'$ref': 'desc/settings/settings.md'}

Documentation Provider Profile APIs.io OpenAPI GitHub

Palo Alto Networks Settings API is one of 741 APIs that Palo Alto Networks publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Settings. The published artifact set on APIs.io includes an OpenAPI specification.

This API exposes 83 operations across 47 paths, and defines 65 schemas. It is described by OpenAPI 3.2.0, at version 1.0.

Requests are made against 16 base URLs: https://api.prismacloud.io, https://api2.prismacloud.io, https://api3.prismacloud.io, https://api4.prismacloud.io, https://api.anz.prismacloud.io, https://api.eu.prismacloud.io, https://api2.eu.prismacloud.io, https://api.gov.prismacloud.io, https://api.prismacloud.cn, https://api.ca.prismacloud.io, https://api.sg.prismacloud.io, https://api.uk.prismacloud.io, https://api.ind.prismacloud.io, https://api.jp.prismacloud.io, https://api.fr.prismacloud.io, PATH_TO_CONSOLE.

83 operations 47 paths 65 schemas 1 DELETE38 GET40 POST4 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
1.0
Base URL
https://{firewall}/api/
Authentication
API Key
Resource Areas
1

Authentication & Security 1

Palo Alto Networks Settings API declares 1 security scheme for authenticating requests. An API key is passed in the header as x-redlock-auth (x-redlock-auth).

  • x-redlock-auth — The x-redlock-auth value is a JSON Web Token (JWT).

Paths & Operations 83

Across 47 paths, the API surfaces 83 operations — 1 DELETE, 38 GET, 40 POST, 4 PUT. Each is listed below with its method, path, parameters, and response codes.

Settings 83

Settings. 39 operations in this definition.

POST
/api/v34.03/settings/certificates
Add Certificate Settings for Clients Accessing a Custom CA
post-settings-certificates body → 200default
GET
/api/v34.03/settings/certs
Get Certificate Settings for Prisma Cloud Compute
get-settings-certs → 200default
POST
/api/v34.03/settings/certs
Add Certificate Settings for Prisma Cloud Compute
post-settings-certs body → 200default
POST
/api/v34.03/settings/console-certificate
Add Certificate Settings for Clients Accessing Prisma Cloud Compute
post-settings-console-certificate body → 200default
GET
/api/v34.03/settings/custom-labels
Get Alert Labels
get-settings-custom-labels → 200default
POST
/api/v34.03/settings/custom-labels
Add Alert Labels
post-settings-custom-labels body → 200default
GET
/api/v34.03/settings/defender
Get Advanced Defender Settings
get-settings-defender → 200default
GET
/api/v34.03/settings/intelligence
Get Intelligence Stream Settings
get-settings-intelligence → 200default
POST
/api/v34.03/settings/intelligence
Add Intelligence Stream Settings
post-settings-intelligence body → 200default
GET
/api/v34.03/settings/ldap
Get LDAP Integration Settings
get-settings-ldap → 200default
POST
/api/v34.03/settings/ldap
Add LDAP Integration Settings
post-settings-ldap body → 200default
GET
/api/v34.03/settings/license
Get Prisma Cloud Compute License
get-settings-license → 200default
POST
/api/v34.03/settings/license
Add Prisma Cloud Compute License
post-settings-license body → 200default
GET
/api/v34.03/settings/logging
Get Logging Settings
get-settings-logging → 200default
POST
/api/v34.03/settings/logging
Add Logging Settings
post-settings-logging body → 200default
GET
/api/v34.03/settings/logon
Get Logon Settings
get-settings-logon → 200default
POST
/api/v34.03/settings/logon
Add Logon Settings
post-settings-logon body → 200default
GET
/api/v34.03/settings/oauth
Get OAuth Settings
get-settings-oauth → 200default
POST
/api/v34.03/settings/oauth
Add OAuth Settings
post-settings-oauth body → 200default
GET
/api/v34.03/settings/oidc
Get Open ID Connect Settings
get-settings-oidc → 200default
POST
/api/v34.03/settings/oidc
Add Open ID Connect Settings
post-settings-oidc body → 200default
GET
/api/v34.03/settings/proxy
Get Proxy Settings of Prisma Cloud Compute
get-settings-proxy → 200default
POST
/api/v34.03/settings/proxy
Add Proxy Settings for Prisma Cloud Compute
post-settings-proxy body → 200default
GET
/api/v34.03/settings/registry
Get Registry Settings
get-settings-registry → 200default
POST
/api/v34.03/settings/registry
Add Registry Settings
post-settings-registry 1 param body → 200default
PUT
/api/v34.03/settings/registry
Update Registry Settings
put-settings-registry 1 param body → 200default
GET
/api/v34.03/settings/saml
Get SAML Settings of Prisma Cloud Compute
get-settings-saml → 200default
POST
/api/v34.03/settings/saml
Add SAML Settings for Prisma Cloud Compute
post-settings-saml body → 200default
GET
/api/v34.03/settings/scan
Get Global Scan Settings
get-settings-scan → 200default
POST
/api/v34.03/settings/scan
Add Global Scan Settings
post-settings-scan body → 200default
GET
/api/v34.03/settings/tas
Get TAS Settings
get-settings-tas → 200default
POST
/api/v34.03/settings/tas
Add TAS Settings
post-settings-tas body → 200default
GET
/api/v34.03/settings/telemetry
Get Telemetry Settings
get-settings-telemetry → 200default
POST
/api/v34.03/settings/telemetry
Enable or Disable Telemetry Settings
post-settings-telemetry body → 200default
POST
/api/v34.03/settings/trusted-certificate
Add a Certificate to a Trusted Certificate List
post-settings-trusted-certificate body → 200default
POST
/api/v34.03/settings/trusted-certificates
Add Trusted Certificate Settings
post-settings-trusted-certificates body → 200default
GET
/api/v34.03/settings/vm
Get VM Image Scan Settings
get-settings-vm → 200default
PUT
/api/v34.03/settings/vm
Update VM Image Scan Settings
put-settings-vm body → 200default
GET
/api/v34.03/settings/wildfire
Wild Fire Settings
get-settings-wildfire → 200default
POST
/api/v34.04/settings/certificates
Add Certificate Settings for Clients Accessing a Custom CA
post-settings-certificates body → 200default
GET
/api/v34.04/settings/certs
Get Certificate Settings for Prisma Cloud Compute
get-settings-certs → 200default
POST
/api/v34.04/settings/certs
Add Certificate Settings for Prisma Cloud Compute
post-settings-certs body → 200default
POST
/api/v34.04/settings/console-certificate
Add Certificate Settings for Clients Accessing Prisma Cloud Compute
post-settings-console-certificate body → 200default
GET
/api/v34.04/settings/custom-labels
Get Alert Labels
get-settings-custom-labels → 200default
POST
/api/v34.04/settings/custom-labels
Add Alert Labels
post-settings-custom-labels body → 200default
GET
/api/v34.04/settings/defender
Get Advanced Defender Settings
get-settings-defender → 200default
GET
/api/v34.04/settings/intelligence
Get Intelligence Stream Settings
get-settings-intelligence → 200default
POST
/api/v34.04/settings/intelligence
Add Intelligence Stream Settings
post-settings-intelligence body → 200default
GET
/api/v34.04/settings/ldap
Get LDAP Integration Settings
get-settings-ldap → 200default
POST
/api/v34.04/settings/ldap
Add LDAP Integration Settings
post-settings-ldap body → 200default
GET
/api/v34.04/settings/license
Get Prisma Cloud Compute License
get-settings-license → 200default
POST
/api/v34.04/settings/license
Add Prisma Cloud Compute License
post-settings-license body → 200default
GET
/api/v34.04/settings/logging
Get Logging Settings
get-settings-logging → 200default
POST
/api/v34.04/settings/logging
Add Logging Settings
post-settings-logging body → 200default
GET
/api/v34.04/settings/logon
Get Logon Settings
get-settings-logon → 200default
POST
/api/v34.04/settings/logon
Add Logon Settings
post-settings-logon body → 200default
GET
/api/v34.04/settings/oauth
Get OAuth Settings
get-settings-oauth → 200default
POST
/api/v34.04/settings/oauth
Add OAuth Settings
post-settings-oauth body → 200default
GET
/api/v34.04/settings/oidc
Get Open ID Connect Settings
get-settings-oidc → 200default
POST
/api/v34.04/settings/oidc
Add Open ID Connect Settings
post-settings-oidc body → 200default
GET
/api/v34.04/settings/proxy
Get Proxy Settings of Prisma Cloud Compute
get-settings-proxy → 200default
POST
/api/v34.04/settings/proxy
Add Proxy Settings for Prisma Cloud Compute
post-settings-proxy body → 200default
GET
/api/v34.04/settings/registry
Get Registry Settings
get-settings-registry → 200default
POST
/api/v34.04/settings/registry
Add Registry Settings
post-settings-registry 1 param body → 200default
PUT
/api/v34.04/settings/registry
Update Registry Settings
put-settings-registry 1 param body → 200default
GET
/api/v34.04/settings/saml
Get SAML Settings of Prisma Cloud Compute
get-settings-saml → 200default
POST
/api/v34.04/settings/saml
Add SAML Settings for Prisma Cloud Compute
post-settings-saml body → 200default
GET
/api/v34.04/settings/scan
Get Global Scan Settings
get-settings-scan → 200default
POST
/api/v34.04/settings/scan
Add Global Scan Settings
post-settings-scan body → 200default
GET
/api/v34.04/settings/tas
Get TAS Settings
get-settings-tas → 200default
POST
/api/v34.04/settings/tas
Add TAS Settings
post-settings-tas body → 200default
GET
/api/v34.04/settings/telemetry
Get Telemetry Settings
get-settings-telemetry → 200default
POST
/api/v34.04/settings/telemetry
Enable or Disable Telemetry Settings
post-settings-telemetry body → 200default
POST
/api/v34.04/settings/trusted-certificate
Add a Certificate to a Trusted Certificate List
post-settings-trusted-certificate body → 200default
POST
/api/v34.04/settings/trusted-certificates
Add Trusted Certificate Settings
post-settings-trusted-certificates body → 200default
GET
/api/v34.04/settings/vm
Get VM Image Scan Settings
get-settings-vm → 200default
PUT
/api/v34.04/settings/vm
Update VM Image Scan Settings
put-settings-vm body → 200default
GET
/api/v34.04/settings/wildfire
Wild Fire Settings
get-settings-wildfire → 200default
GET
/settings/enterprise
Enterprise Settings - GET
get-enterprise-settings → 200500
POST
/settings/enterprise
Enterprise Settings - POST
update-enterprise-settings body → 200400500
POST
/appid/api/v1/satellite
Add Satellite Details
addClusterInfo 1 param body → 200400401403
GET
/appid/api/v1/satellite
List Cluster Details
listClusters 1 param → 200400401403
DELETE
/appid/api/v1/satellite/{id}
Delete Satellite Details
deleteCluster 2 params → 200400401403

Schemas 65

The contract defines 65 schemas that model the data the API accepts and returns. The most detailed are shared.RegistrySpecification (26 properties), cred.Credential (25 properties), shared.VMSpecification (15 properties), shared.ScanSettings (15 properties). Each schema is shown below with its type and property counts.

cred.Type
string
Type specifies the credential type
types.ConsoleCertificateSettings
object
ConsoleCertificateSettings are the console certificate settings
4 properties
defender.Settings
object
Settings is the Defender settings
7 properties
shared.TASRemoteBlobstoreConfig
object
TASRemoteBlobstoreConfig contains remote blobstore details
5 properties
common.CloudMetadata
object
CloudMetadata is the metadata for a cloud provider managed asset (e.g., as part of AWS/GCP/Azure/OCI)
15 properties
types.HPKPSettings
object
HPKPSettings represents the public key pinning settings
3 properties
shared.LicenseContractType
string
LicenseContractType is the license contract type
cred.AzureSPInfo
object
AzureSPInfo contains the Azure credentials needed for certificate based authentications
4 properties
common.ACIMetadata
object
1 property
defender.Category
string
Category represents the defender target category
api.LicenseRequest
object
LicenseRequest is a request to setup a new license
1 property
types.CertificateSettings
object
CertificateSettings are the certificate settings
2 properties
common.CloudRunMetadata
object
2 properties
shared.ScanSettings
object
ScanSettings are global settings for image/host/container and registry scanning
15 properties
shared.WildFireSettings
object
WildFireSettings are the settings for WildFire API requests
4 properties
common.GCPCloudMetadata
object
1 property
common.CloudProvider
string
CloudProvider specifies the cloud provider name
-_shared.VMSpecification
array
common.ExternalLabel
object
ExternalLabel holds an external label with a source and timestamp
5 properties
shared.TrustedCertSignature
object
TrustedCertSignature represents a trusted cert settings
5 properties
shared.JFrogRepoType
string
JFrogRepoType represents the type of JFrog Artifactory repository
string
string
common.Secret
object
Secret Stores the plain and encrypted version of a value. The plain version is not stored in a database
2 properties
types.LogonSettings
object
LogonSettings are settings associated with the login properties
5 properties
common.ImageType
string
ImageType is the type of a VM image. For example, in the case of Azure this is one of marketplace/managed/gallery.
shared.RegistryOSType
string
RegistryOSType specifies the registry images base OS type
types.CertData
object
CertData is used to add a custom certificate to the product
1 property
identity.SamlSettings
object
SamlSettings are the saml connectivity settings
13 properties
-_shared.TASDropletSpecification
array
intelligence.IntelligenceSettings
object
IntelligenceSettings are the intelligence service settings
9 properties
shared.TASDropletSpecification
object
TASDropletSpecification specify which droplets to scan
6 properties
shared.TrustedCertSettings
object
TrustedCertSettings are settings for trusted certs
3 properties
shared.VMSpecification
object
VMSpecification contains information for setting up and connecting to the image
15 properties
cred.TemporaryToken
object
TemporaryToken is a temporary session token for cloud provider APIs AWS - https://docs.aws.amazon.com/IAM/latest/UserGuide/idcredentialstemp.html GCP - https:/…
5 properties
identity.ProviderName
string
ProviderName is the identity provider name
shared.GitlabRegistrySpec
object
GitlabRegistrySpec represents a specification for registry scanning in GitLab
5 properties
shared.LicenseTier
string
LicenseTier represents the license tier of the customer
common.ExternalLabelSourceType
string
ExternalLabelSourceType indicates the source of the labels
shared.CustomLabelsSettings
object
CustomLabelsSettings are customized label names that are used to augment audit events They can either be docker labels (which appears in the container label sp…
1 property
cred.AzureMIType
string
cred.OCICred
object
OCICred are additional parameters required for OCI credentials
2 properties
shared.WildFirePolicy
object
WildFirePolicy is the global wildfire usage policy, set by the client
6 properties
cred.Credential
object
Credential specifies the authentication data of an external provider
25 properties
types.TelemetrySettings
object
TelemetrySettings is the telemetry settings
1 property
types.CertSettings
object
CertSettings are the certificates settings
3 properties
shared.DefenderLicenseDetails
object
DefenderLicenseDetails represents a single defender license details
2 properties
shared.License
object
License represent the customer license
11 properties
common.ProxySettings
object
ProxySettings are the http proxy settings
5 properties
identity.SamlType
string
SamlType represents the type of a SAML configured settings
shared.LoggerSetting
object
LoggerSetting are a specific logger settings
3 properties
identity.LdapSettings
object
LdapSettings are the ldap connectivity settings
10 properties
shared.RegistrySettings
object
RegistrySettings contains each registry's unique settings
3 properties
common.AzureMetadata
object
2 properties
shared.SyslogSettings
object
SyslogSettings are the syslog settings
6 properties
identity.ProviderSettings
object
ProviderSettings are the Oauth/ OpenID Connect connectivity settings
13 properties
shared.LoggingSettings
object
LoggingSettings are the logging settings
5 properties
shared.RegistrySpecification
object
RegistrySpecification contains information for connecting to local/remote registry
26 properties
EnterpriseSettingsRequestModel
object
Model used for EnterpriseSettings
12 properties
ClusterInfoResponse
object
8 properties
ErrorResponse
object
1 property
ClusterMetaDataResponse
object
2 properties
Error
object
5 properties 3 required
ClusterInfo
object
2 properties 1 required
InnerError
object
3 properties
EnterpriseSettingsRequestModel_2
object
Model used for EnterpriseSettings
13 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

palo-alto-networks-settings-api-openapi.yml Raw ↑

Other APIs Palo Alto Networks publishes across the network.

PAN-OS XML API
AE Profile APIs.io
PAN-OS OpenConfig API
AE Profile APIs.io
Panorama API
AE Profile APIs.io
AutoFocus API (Deprecated)
AE Profile APIs.io
Prisma SASE Service Status API
AE Profile APIs.io
Cross-Platform Service Status API
AE Profile APIs.io
SASE Authentication Service API
AE Profile APIs.io
Expedition API (Deprecated)
AE Profile APIs.io
VM-Series Licensing API
AE Profile APIs.io
Palo Alto Networks 5G Deregistered Trend API
AE Profile APIs.io
Palo Alto Networks 5G Network Interconnects and Bandwidth API
AE Profile APIs.io
Palo Alto Networks 5G Registered Trend API
AE Profile APIs.io
#Settings
← Back to P APIs
API Details
ID
palo-alto-networks:palo-alto-networks-settings-api
Base URL
https://{firewall}/api/
Docs
https://pan.dev/panos/docs/xmlapi/
Provider
Palo Alto Networks
APIs.io →  GitHub →
Explore more
All APIs Providers APIs.io Network
Work with this as data

Every API here is available over the API and to AI agents over MCP. APIs is not yet its own endpoint on the v1 API. Reach this content through network search and the tag graph, or the MCP server below.

Installs https://mcp.apievangelist.com/mcp in Claude, Cursor, VS Code and the rest — one button, every client.

MCP tools for apis
4 tools reach this content
  • search_api_evangelistSearch every content type across the network at once.
  • find_relatedThe shared-tag relevance graph — what else covers this.
  • get_tagEverything one tag labels, across all content types.
  • guide_topicPRO — a curated bundle for a topic: area, guidance, rules, papers, stories, services.
All tools & prompts
Call it yourself
curl for this page
Search the network for this 
curl "https://api.apievangelist.com/v1/search?q=palo-alto-networks-settings-api-2&limit=10"
Everything under a tag 
curl "https://api.apievangelist.com/v1/tags/palo-alto-networks-settings-api-2"

Discovery needs no key. Full bodies and the synthesis endpoints are Pro.

Get an API key

Free tier, no email required. Sign in with whichever identity you already have.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have. Your account

Where this information came from

This is an independent, third-party profile of Palo Alto Networks Settings API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.