Palo Alto Networks Security Rules API
The SecurityRules API from Palo Alto Networks — 5 operation(s) for securityrules.
The SecurityRules API from Palo Alto Networks — 5 operation(s) for securityrules.
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-securityrules-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:
title: Palo Alto Networks Security Rules API
x-refined-note:
- x-logo differs across the merged source definitions and was not carried
version: '1.0'
description: 'Operations tagged SecurityRules across 6 of this provider''s published API definitions: palo-alto-access-prisma-access-config-securityrules-openapi.yaml, palo-alto-cloud-ngfw-api-openapi-original.yml, palo-alto-cloudngfw-aws-securityrules-openapi.yaml, palo-alto-networks-securityrules-api-openapi.yml, palo-alto-prisma-access-api-openapi-original.yml, palo-alto-strata-cloud-manager-api-openapi-original.yml. Each path carries the servers of the definition it was published in.'
servers:
- url: https://api.sase.paloaltonetworks.com
- url: https://api.{region}.aws.cloudngfw.paloaltonetworks.com/v1
description: Cloud NGFW for AWS regional API endpoint.
variables:
region:
description: AWS region where Cloud NGFW is deployed (e.g., us-east-1, us-west-2, eu-west-1).
default: us-east-1
- url: https://api.us-east-1.aws.cloudngfw.paloaltonetworks.com
- url: https://api.stratacloud.paloaltonetworks.com/aiops/bpa/v1
description: AIOps for NGFW BPA API production server.
- url: https://api.sase.paloaltonetworks.com/sse/config/v1
description: Prisma Access SASE configuration API server.
- url: https://api.strata.paloaltonetworks.com
description: Strata Cloud Manager API production endpoint.
tags:
- name: SecurityRules
paths:
/sse/config/v1/security-rules:
get:
description: 'List [security rules](https://docs.paloaltonetworks.com/network-security/security-policy/security-rules).
'
operationId: get-sse-config-v1-security-rules
parameters:
- $ref: '#/components/parameters/limit-optional'
- $ref: '#/components/parameters/offset-optional'
- $ref: '#/components/parameters/position'
- $ref: '#/components/parameters/folder'
- $ref: '#/components/parameters/name-optional'
responses:
'200':
content:
application/json:
schema:
properties:
data:
allOf:
- items:
$ref: '#/components/schemas/security-rules'
type: array
limit:
default: 200
type: number
offset:
default: 0
type: number
total:
type: number
type: object
description: List of security rules
'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 security rules
tags:
- SecurityRules
post:
description: 'Create a security rule.
'
operationId: post-sse-config-v1-security-rules
parameters:
- $ref: '#/components/parameters/position'
- $ref: '#/components/parameters/folder'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/security-rules'
description: The security rule you want to create
responses:
'200':
$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 a security rule
tags:
- SecurityRules
servers:
- url: https://api.sase.paloaltonetworks.com
/sse/config/v1/security-rules/{id}:
delete:
description: 'Delete a security rule.
'
operationId: delete-sse-config-v1-security-rules-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 security rule
tags:
- SecurityRules
get:
description: 'Get a [security rule](https://docs.paloaltonetworks.com/network-security/security-policy/security-rules).
'
operationId: get-sse-config-v1-security-rules-id
parameters:
- $ref: '#/components/parameters/uuid-required'
responses:
'200':
content:
application/json:
schema:
allOf:
- items:
$ref: '#/components/schemas/security-rules'
type: array
description: Get security rule 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 a security rule
tags:
- SecurityRules
put:
description: 'Modify a security rule.
'
operationId: put-sse-config-v1-security-rules-id
parameters:
- $ref: '#/components/parameters/uuid-required'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/security-rules'
description: The security rule 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 security rule
tags:
- SecurityRules
servers:
- url: https://api.sase.paloaltonetworks.com
/sse/config/v1/security-rules/{id}:move:
post:
description: 'Move a security rule.
'
operationId: post-sse-config-v1-security-rules-id:move
parameters:
- $ref: '#/components/parameters/uuid-required'
- $ref: '#/components/parameters/folder'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/rule-based-move'
description: The security rule you want to move
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'
'409':
$ref: '#/components/responses/conflict_errors'
default:
$ref: '#/components/responses/default_errors'
security:
- Bearer: []
summary: Move a security rule
tags:
- SecurityRules
servers:
- url: https://api.sase.paloaltonetworks.com
/config/rulestacks/{rulestack}/security-rules:
get:
operationId: listSecurityRules
summary: Palo Alto Networks List Security Rules
description: Returns all security rules in the specified rule stack. Security rules are evaluated in priority order and define traffic inspection and forwarding policy for the Cloud NGFW.
tags:
- SecurityRules
parameters:
- $ref: '#/components/parameters/rulestack'
- name: maxresults
in: query
description: Maximum number of rules to return.
schema:
type: integer
default: 100
example: 100
- name: nexttoken
in: query
description: Pagination token from a previous response.
schema:
type: string
example: example-nexttoken
- name: listtype
in: query
description: Whether to return candidate or running configuration.
schema:
type: string
enum:
- CANDIDATE
- RUNNING
default: CANDIDATE
example: CANDIDATE
responses:
'200':
description: Security rules returned successfully.
content:
application/json:
schema:
type: object
properties:
Response:
type: object
properties:
RuleListCandidate:
type: array
items:
$ref: '#/components/schemas/SecurityRuleSummary'
NextToken:
type: string
ResponseStatus:
$ref: '#/components/schemas/ResponseStatus'
examples:
ListSecurityRules200Example:
summary: Default listSecurityRules 200 response
x-microcks-default: true
value:
Response:
RuleListCandidate:
- Priority: 234
RuleName: Production Policy 12
Enabled: false
NextToken: example-NextToken
ResponseStatus:
ErrorCode: 0
Reason: ''
'400':
$ref: '#/components/responses/BadRequest'
'401':
$ref: '#/components/responses/Unauthorized'
'404':
$ref: '#/components/responses/NotFound'
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
security:
- awsSigV4: []
post:
operationId: createSecurityRule
summary: Palo Alto Networks Create Security Rule
description: Creates a new security rule in the rule stack at the specified priority. Rules with lower priority numbers are evaluated first. Define source and destination criteria, applications, and the enforcement action.
tags:
- SecurityRules
parameters:
- $ref: '#/components/parameters/rulestack'
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/SecurityRuleRequest'
examples:
CreateSecurityRuleRequestExample:
summary: Default createSecurityRule request
x-microcks-default: true
value:
Priority: 48316
RuleEntry:
RuleName: Primary Gateway 01
Description: Activity Security blocked suspicious threat alert activity firewall.
Enabled: true
Source:
Cidrs:
- example-Cidrs_item
Countries:
- example-Countries_item
Feeds:
- example-Feeds_item
- example-Feeds_item
PrefixLists:
- example-PrefixLists_item
- example-PrefixLists_item
Destination:
Cidrs:
- example-Cidrs_item
- example-Cidrs_item
Countries:
- example-Countries_item
- example-Countries_item
Feeds:
- example-Feeds_item
FqdnLists:
- example-FqdnLists_item
- example-FqdnLists_item
PrefixLists:
- example-PrefixLists_item
Applications:
- ssh
Protocol: APPLICATION-DEFAULT
Action: DenySilent
responses:
'200':
description: Security rule created successfully.
content:
application/json:
schema:
type: object
properties:
Response:
$ref: '#/components/schemas/SecurityRule'
ResponseStatus:
$ref: '#/components/schemas/ResponseStatus'
examples:
CreateSecurityRule200Example:
summary: Default createSecurityRule 200 response
x-microcks-default: true
value:
Response:
Priority: 707
RuleEntry:
RuleName: Primary Gateway 01
Description: Firewall alert incident monitoring investigation threat threat blocked activity monitoring.
Enabled: true
Source:
Cidrs:
- example-Cidrs_item
- example-Cidrs_item
Countries:
- example-Countries_item
- example-Countries_item
Feeds:
- example-Feeds_item
PrefixLists:
- example-PrefixLists_item
NegateSource: false
Destination:
Cidrs:
- example-Cidrs_item
Countries:
- example-Countries_item
- example-Countries_item
Feeds:
- example-Feeds_item
FqdnLists:
- example-FqdnLists_item
- example-FqdnLists_item
PrefixLists:
- example-PrefixLists_item
NegateDestination: false
Applications:
- dns
- web-browsing
Category:
URLCategoryNames:
- Production Sensor 06
Feeds:
- example-Feeds_item
Protocol: UDP
Action: Allow
DecryptionRuleType: SSLOutboundInspection
AuditComment: Rule malware monitoring malware firewall violation suspicious detected applied firewall detected applied.
ResponseStatus:
ErrorCode: 0
Reason: ''
'400':
$ref: '#/components/responses/BadRequest'
'401':
$ref: '#/components/responses/Unauthorized'
'409':
$ref: '#/components/responses/Conflict'
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
security:
- awsSigV4: []
servers:
- url: https://api.{region}.aws.cloudngfw.paloaltonetworks.com/v1
description: Cloud NGFW for AWS regional API endpoint.
variables:
region:
description: AWS region where Cloud NGFW is deployed (e.g., us-east-1, us-west-2, eu-west-1).
default: us-east-1
/config/rulestacks/{rulestack}/security-rules/{priority}:
get:
operationId: getSecurityRule
summary: Palo Alto Networks Get Security Rule
description: Returns a specific security rule by its priority number within the rule stack.
tags:
- SecurityRules
parameters:
- $ref: '#/components/parameters/rulestack'
- $ref: '#/components/parameters/priority'
- name: candidate
in: query
description: Return candidate configuration if true, running configuration if false.
schema:
type: boolean
default: true
example: true
responses:
'200':
description: Security rule returned successfully.
content:
application/json:
schema:
type: object
properties:
Response:
$ref: '#/components/schemas/SecurityRule'
ResponseStatus:
$ref: '#/components/schemas/ResponseStatus'
examples:
GetSecurityRule200Example:
summary: Default getSecurityRule 200 response
x-microcks-default: true
value:
Response:
Priority: 707
RuleEntry:
RuleName: Primary Gateway 01
Description: Firewall alert incident monitoring investigation threat threat blocked activity monitoring.
Enabled: true
Source:
Cidrs:
- example-Cidrs_item
- example-Cidrs_item
Countries:
- example-Countries_item
- example-Countries_item
Feeds:
- example-Feeds_item
PrefixLists:
- example-PrefixLists_item
NegateSource: false
Destination:
Cidrs:
- example-Cidrs_item
Countries:
- example-Countries_item
- example-Countries_item
Feeds:
- example-Feeds_item
FqdnLists:
- example-FqdnLists_item
- example-FqdnLists_item
PrefixLists:
- example-PrefixLists_item
NegateDestination: false
Applications:
- dns
- web-browsing
Category:
URLCategoryNames:
- Production Sensor 06
Feeds:
- example-Feeds_item
Protocol: UDP
Action: Allow
DecryptionRuleType: SSLOutboundInspection
AuditComment: Rule malware monitoring malware firewall violation suspicious detected applied firewall detected applied.
ResponseStatus:
ErrorCode: 0
Reason: ''
'401':
$ref: '#/components/responses/Unauthorized'
'404':
$ref: '#/components/responses/NotFound'
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
security:
- awsSigV4: []
put:
operationId: updateSecurityRule
summary: Palo Alto Networks Update Security Rule
description: Updates an existing security rule at the specified priority in the rule stack.
tags:
- SecurityRules
parameters:
- $ref: '#/components/parameters/rulestack'
- $ref: '#/components/parameters/priority'
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/SecurityRuleRequest'
examples:
UpdateSecurityRuleRequestExample:
summary: Default updateSecurityRule request
x-microcks-default: true
value:
Priority: 48316
RuleEntry:
RuleName: Primary Gateway 01
Description: Activity Security blocked suspicious threat alert activity firewall.
Enabled: true
Source:
Cidrs:
- example-Cidrs_item
Countries:
- example-Countries_item
Feeds:
- example-Feeds_item
- example-Feeds_item
PrefixLists:
- example-PrefixLists_item
- example-PrefixLists_item
Destination:
Cidrs:
- example-Cidrs_item
- example-Cidrs_item
Countries:
- example-Countries_item
- example-Countries_item
Feeds:
- example-Feeds_item
FqdnLists:
- example-FqdnLists_item
- example-FqdnLists_item
PrefixLists:
- example-PrefixLists_item
Applications:
- ssh
Protocol: APPLICATION-DEFAULT
Action: DenySilent
responses:
'200':
description: Security rule updated successfully.
content:
application/json:
schema:
type: object
properties:
Response:
$ref: '#/components/schemas/SecurityRule'
ResponseStatus:
$ref: '#/components/schemas/ResponseStatus'
examples:
UpdateSecurityRule200Example:
summary: Default updateSecurityRule 200 response
x-microcks-default: true
value:
Response:
Priority: 707
RuleEntry:
RuleName: Primary Gateway 01
Description: Firewall alert incident monitoring investigation threat threat blocked activity monitoring.
Enabled: true
Source:
Cidrs:
- example-Cidrs_item
- example-Cidrs_item
Countries:
- example-Countries_item
- example-Countries_item
Feeds:
- example-Feeds_item
PrefixLists:
- example-PrefixLists_item
NegateSource: false
Destination:
Cidrs:
- example-Cidrs_item
Countries:
- example-Countries_item
- example-Countries_item
Feeds:
- example-Feeds_item
FqdnLists:
- example-FqdnLists_item
- example-FqdnLists_item
PrefixLists:
- example-PrefixLists_item
NegateDestination: false
Applications:
- dns
- web-browsing
Category:
URLCategoryNames:
- Production Sensor 06
Feeds:
- example-Feeds_item
Protocol: UDP
Action: Allow
DecryptionRuleType: SSLOutboundInspection
AuditComment: Rule malware monitoring malware firewall violation suspicious detected applied firewall detected applied.
ResponseStatus:
ErrorCode: 0
Reason: ''
'400':
$ref: '#/components/responses/BadRequest'
'401':
$ref: '#/components/responses/Unauthorized'
'404':
$ref: '#/components/responses/NotFound'
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
security:
- awsSigV4: []
delete:
operationId: deleteSecurityRule
summary: Palo Alto Networks Delete Security Rule
description: Deletes the security rule at the specified priority from the rule stack.
tags:
- SecurityRules
parameters:
- $ref: '#/components/parameters/rulestack'
- $ref: '#/components/parameters/priority'
responses:
'200':
description: Security rule deleted successfully.
content:
application/json:
schema:
type: object
properties:
ResponseStatus:
$ref: '#/components/schemas/ResponseStatus'
examples:
DeleteSecurityRule200Example:
summary: Default deleteSecurityRule 200 response
x-microcks-default: true
value:
ResponseStatus:
ErrorCode: 0
Reason: ''
'401':
$ref: '#/components/responses/Unauthorized'
'404':
$ref: '#/components/responses/NotFound'
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
security:
- awsSigV4: []
servers:
- url: https://api.{region}.aws.cloudngfw.paloaltonetworks.com/v1
description: Cloud NGFW for AWS regional API endpoint.
variables:
region:
description: AWS region where Cloud NGFW is deployed (e.g., us-east-1, us-west-2, eu-west-1).
default: us-east-1
/v1/config/rulestacks/{rulestackname}/rulelists/{rulelistname}:
get:
description: 'List all security rules associated with a rulestack in priority order.
'
operationId: get-v1-config-rulestacks-rulestackname-rulelists-rulelistname
parameters:
- description: 'The name of the rulestack.
'
in: path
name: rulestackname
required: true
schema:
type: string
- description: 'The name of the rulelist.
'
in: path
name: rulelistname
required: true
schema:
type: string
- description: ''
in: query
name: nexttoken
required: false
schema:
title: Nexttoken
type: string
- description: ''
in: query
name: candidate
required: false
schema:
default: true
title: Candidate
type: boolean
- description: ''
in: query
name: running
required: false
schema:
default: false
title: Running
type: boolean
- description: ''
in: query
name: uncommitted
required: false
schema:
default: false
title: Uncommitted
type: boolean
- description: ''
in: query
name: maxresults
required: false
schema:
default: 1024
maximum: 1024
minimum: 1
title: Maxresults
type: integer
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/ListSecurityRulesResponse'
description: OK
summary: List security rules
tags:
- SecurityRules
post:
description: 'Create a security rule for a rulestack.
'
operationId: post-v1-config-rulestacks-rulestackname-rulelists-rulelistname
parameters:
- description: 'The name of the rulestack.
'
in: path
name: rulestackname
required: true
schema:
type: string
- description: 'The name of the rulelist.
'
in: path
name: rulelistname
required: true
schema:
type: string
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/CreateSecurityRuleRequest'
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/CreateSecurityRuleResponse'
description: OK
summary: Create security rule
tags:
- SecurityRules
servers:
- url: https://api.us-east-1.aws.cloudngfw.paloaltonetworks.com
/v1/config/rulestacks/{rulestackname}/rulelists/{rulelistname}/priorities/{priority}:
delete:
description: 'Delete a security rule associated with a rulestack.
'
operationId: delete-v1-config-rulestacks-rulestackname-rulelists-rulelistname-priorities-priority
parameters:
- description: 'The name of the rulestack.
'
in: path
name: rulestackname
required: true
schema:
type: string
- description: 'The name of the rulelist.
'
in: path
name: rulelistname
required: true
schema:
type: string
- description: ''
in: path
name: priority
required: true
schema:
type: string
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/DeleteSecurityRuleRequest'
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/DeleteSecurityRuleResponse'
description: OK
summary: Delete security rule
tags:
- SecurityRules
get:
description: 'Retrieve the security rules associated with a rulestack.
'
operationId: get-v1-config-rulestacks-rulestackname-rulelists-rulelistname-priorities-priority
parameters:
- description: 'The name of the rulestack.
'
in: path
name: rulestackname
required: true
schema:
type: string
- description: 'The name of the rulelist.
'
in: path
name: rulelistname
required: true
schema:
type: string
- description: ''
in: path
name: priority
required: true
schema:
type: string
- description: ''
in: query
name: Candidate
required: false
schema:
default: true
title: Candidate
type: boolean
- description: ''
in: query
name: Running
required: false
schema:
default: false
title: Running
type: boolean
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/DescribeSecurityRuleResponse'
description: OK
summary: Retrieve security rule
tags:
- SecurityRules
put:
description: 'Update a security rule associated with a rulestack.
'
operationId: put-v1-config-rulestacks-rulestackname-rulelists-rulelistname-priorities-priority
parameters:
- description: 'The name of the rulestack.
'
in: path
name: rulestackname
required: true
schema:
type: string
- description: 'The name of the rulelist.
'
in: path
name: rulelistname
required: true
schema:
type: string
- description: ''
in: path
name: priority
required: true
schema:
type: string
requestBody:
content:
application/json:
# --- truncated at 32 KB (136 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/palo-alto-networks/refs/heads/main/openapi/palo-alto-networks-securityrules-api-openapi.yml