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

Palo Alto Networks Security Rules API

Security Rules

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

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

This API exposes 17 operations across 8 paths, and defines 29 schemas. It is described by OpenAPI 3.2.0, at version 2.0.0.

Requests are made against 2 base URLs: https://api.strata.paloaltonetworks.com/config/security/v1, https://api.sase.paloaltonetworks.com/sse/config/v1.

17 operations 8 paths 29 schemas 3 DELETE6 GET5 POST3 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
2.0.0
Base URL
https://{firewall}/api/
Authentication
OAuth 2.0, HTTP Bearer, HTTP Bearer, API Key, HTTP Bearer, OAuth 2.0, HTTP Bearer
License
Terms of Service
Resource Areas
1

Authentication & Security 7

Palo Alto Networks Security Rules API declares 7 security schemes for authenticating requests. It supports OAuth 2.0 (scmOAuth) using the clientCredentials flow. It accepts HTTP bearer tokens (JWT) (scmToken). It accepts HTTP bearer tokens (Bearer). An API key is passed in the header as Authorization (awsSigV4). It accepts HTTP bearer tokens (JWT) (oauth2Bearer). It supports OAuth 2.0 (oauth2) using the clientCredentials flow. It accepts HTTP bearer tokens (JWT) (bearerAuth). By default, every request must be authenticated.

  • scmOAuth — Strata Cloud Manager APIs authenticate client requests using the OAuth 2.0 Client Credentials flow. Please use the clientid, clientsecret values associated wit…
  • scmToken — Strata Cloud Manager APIs authenticate client requests using the OAuth 2.0 Client Credentials flow. Please use the clientid, clientsecret values associated wit…
  • awsSigV4 — AWS Signature Version 4 (SigV4) signed request. Use an AWS IAM role or user with CloudNGFW IAM permissions. Sign requests using the service name cloudngfw and…
  • oauth2Bearer — OAuth 2.0 Bearer token for SASE platform authentication. Obtain using the clientcredentials grant with your SASE service account client ID and client secret.
  • oauth2 — OAuth 2.0 client credentials flow for obtaining an access token. Requires a client ID and client secret from the Palo Alto Networks SASE identity provider.
  • bearerAuth — OAuth 2.0 access token obtained from https://auth.apps.paloaltonetworks.com/oauth2/accesstoken using a client credentials grant. Generate a service account and…

Paths & Operations 17

Across 8 paths, the API surfaces 17 operations — 3 DELETE, 6 GET, 5 POST, 3 PUT. Each is listed below with its method, path, parameters, and response codes.

Security Rules 17

Security Rules

GET
/security-rules
List security rules
ListRules 7 params → 200400401403404default
POST
/security-rules
Create a security rule
CreateSecurityRules 1 param body → 201400401403409default
GET
/security-rules/{id}
Get a security rule
GetSecurityRulesByID 1 param → 200400401403404default
PUT
/security-rules/{id}
Update a security rule
UpdateSecurityRulesByID 1 param body → 200400401403404409default
DELETE
/security-rules/{id}
Delete a security rule
DeleteSecurityRulesByID 1 param → 200400401403404409default
POST
/security-rules/{id}:move
Move a security rule
MoveSecurityRulesByID 1 param body → 200400401403409default
GET
/sse/config/v1/security-rules
List security rules
get-sse-config-v1-security-rules 5 params → 200400401403404default
POST
/sse/config/v1/security-rules
Create a security rule
post-sse-config-v1-security-rules 2 params body → 200400401403409default
DELETE
/sse/config/v1/security-rules/{id}
Delete a security rule
delete-sse-config-v1-security-rules-id 1 param → 200400401403404409default
GET
/sse/config/v1/security-rules/{id}
Get a security rule
get-sse-config-v1-security-rules-id 1 param → 200400401403404default
PUT
/sse/config/v1/security-rules/{id}
Edit a security rule
put-sse-config-v1-security-rules-id 1 param body → 200400401403404409default
POST
/sse/config/v1/security-rules/{id}:move
Move a security rule
post-sse-config-v1-security-rules-id:move 2 params body → 200400401403409default
GET
/config/rulestacks/{rulestack}/security-rules
Palo Alto Networks List Security Rules
listSecurityRules 4 params → 200400401404
POST
/config/rulestacks/{rulestack}/security-rules
Palo Alto Networks Create Security Rule
createSecurityRule 1 param body → 200400401409
GET
/config/rulestacks/{rulestack}/security-rules/{priority}
Palo Alto Networks Get Security Rule
getSecurityRule 3 params → 200401404
PUT
/config/rulestacks/{rulestack}/security-rules/{priority}
Palo Alto Networks Update Security Rule
updateSecurityRule 2 params body → 200400401404
DELETE
/config/rulestacks/{rulestack}/security-rules/{priority}
Palo Alto Networks Delete Security Rule
deleteSecurityRule 2 params → 200401404

Schemas 29

The contract defines 29 schemas that model the data the API accepts and returns. The most detailed are SecurityRule_2 (18 properties), SecurityRule_3 (18 properties), SecurityRule_5 (18 properties), SecurityRule_4 (18 properties). Each schema is shown below with its type and property counts.

security-rules
object
Represents a Security or Internet security rule. A rule must be one of the policy types AND exist in one scope (folder, snippet, or device).
rule-based-move
object
3 properties 2 required
error_detail_cause_info
object
4 properties
generic_error
object
2 properties
base-rule-properties
object
15 properties 1 required
error_detail_cause_infos
array
SecurityRuleListResponse
object
4 properties
internet-rule-type
object
A simplified security rule for controlling internet access.
security-rule-type
object
A standard security rule for controlling traffic between zones.
7 required
RuleDestination
object
Traffic destination matching criteria for a security rule.
5 properties
ResponseStatus
object
Standard API response status envelope included in all responses.
2 properties
SecurityRuleRequest
object
2 properties 2 required
SecurityRuleSummary
object
3 properties
SecurityRule
object
A security rule within a Cloud NGFW rule stack.
2 properties
RuleSource
object
Traffic source matching criteria for a security rule.
4 properties
ErrorResponse
object
1 property
SecurityRule_3
object
A security policy rule defining traffic matching criteria and enforcement action applied by managed firewalls.
18 properties
DeleteResponse
object
1 property
ErrorResponse_2
object
2 properties
SecurityRule_2
object
18 properties 7 required
SecurityRuleRequest_2
object
15 properties 2 required
SecurityRuleList
object
4 properties
ErrorResponse_3
object
2 properties
SecurityRule_4
object
18 properties 7 required
ErrorResponse_4
object
2 properties
SecurityRuleList_2
object
4 properties
SecurityRuleRequest_3
object
15 properties 2 required
SecurityRule_5
object
A security policy rule defining traffic matching criteria and enforcement action applied by managed firewalls.
18 properties
ErrorResponse_5
object
2 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

palo-alto-networks-security-rules-api-openapi.yml Raw ↑

Other APIs Palo Alto Networks publishes across the network.

PAN-OS XML API
PAN-OS OpenConfig API
Panorama API
AutoFocus API (Deprecated)
Prisma SASE Service Status API
Cross-Platform Service Status API
SASE Authentication Service API
Expedition API (Deprecated)
VM-Series Licensing API
Palo Alto Networks AddressGroups API
Palo Alto Networks CloudAccounts API
Palo Alto Networks DataAssets API
Where this information came from

This is an independent, third-party profile of Palo Alto Networks Security Rules 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.