Palo Alto Networks Manage NGFW V2 API
The ManageNGFW-V2 API from Palo Alto Networks — 15 operation(s) for managengfw-v2.
The ManageNGFW-V2 API from Palo Alto Networks — 15 operation(s) for managengfw-v2.
openapi: 3.2.0
info:
contact: {}
description: "The V2 API provides enhanced operations for managing Cloud NGFW resources. This version introduces new features and improvements for firewall management, including support for managing firewalls by ID and name, content version updates, and feature management.\n\n### Key Features\n\n- Manage firewalls by firewall ID or firewall name\n- Update firewall content versions\n- Configure firewall features \n- Link firewalls across accounts\n- Enhanced log profile and rulestack management\n\n### Permission Policies\n\n| Action | Local Firewall Administrator | Local Rulestack Administrator | Global Rulestack Administrator |\n| -------------------------------------- | :---------------------------: | :---------------------------: | :----------------------------: |\n| Create/Delete Firewall | **☑** | ☐ | ☐ |\n| Update Firewall | **☑** | ☐ | ☐ |\n| Manage Firewall Features | **☑** | ☐ | ☐ |\n| Link Accounts | **☑** | ☐ | ☐ |\n"
title: Manage Cloud NGFW (V2) Manage NGFW V2 API
version: 1.0.0
servers:
- url: https://api.us-east-1.aws.cloudngfw.paloaltonetworks.com
tags:
- name: ManageNGFW-V2
paths:
/v2/linkaccounts:
delete:
description: 'Delete a link account from V2 API configuration.
'
operationId: delete-v2-linkaccounts
parameters:
- description: Authorization
in: header
name: Authorization
required: true
schema:
type: string
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/v2.DeleteLinkAccountAPIInput'
required: true
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/v2.DeleteLinkAccountAPIOutput'
description: OK
'400':
content:
application/json:
schema:
$ref: '#/components/schemas/v2.DeleteLinkAccountAPIOutput'
description: Bad Request
summary: Delete link account
tags:
- ManageNGFW-V2
get:
description: 'List all link accounts configured for V2 API.
'
operationId: get-v2-linkaccounts
parameters:
- description: Max results
in: query
name: maxresults
schema:
type: string
- description: describe the Accounts
in: query
name: describe
schema:
type: string
- description: Next token
in: query
name: nexttoken
schema:
type: string
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/v2.ListLinkAccountsAPIOutput'
description: OK
'400':
content:
application/json:
schema:
$ref: '#/components/schemas/v2.ListLinkAccountsAPIOutput'
description: Bad Request
summary: List link accounts
tags:
- ManageNGFW-V2
post:
description: 'Create a new link account for V2 API access.
'
operationId: post-v2-linkaccounts
parameters:
- description: Authorization
in: header
name: Authorization
required: true
schema:
type: string
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/v2.CreateLinkAccountAPIInput'
required: true
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/v2.CreateLinkAccountAPIOutput'
description: OK
'400':
content:
application/json:
schema:
$ref: '#/components/schemas/v2.CreateLinkAccountAPIOutput'
description: Bad Request
summary: Create link account
tags:
- ManageNGFW-V2
/v2/ngfirewalls:
get:
description: 'List all Cloud NGFW resources in your account using V2 API.
'
operationId: get-v2-ngfirewalls-v2
parameters:
- description: FW region
in: query
name: region
required: true
schema:
type: string
- description: Max results
in: query
name: maxresults
schema:
type: string
- description: describe the FW
in: query
name: describe
schema:
type: string
- description: Next token
in: query
name: nexttoken
schema:
type: string
- description: rulestack name
in: query
name: rulestackname
schema:
type: string
- description: global rulestack name
in: query
name: globalrulestackname
schema:
type: string
- description: Authorization
in: header
name: Authorization
required: true
schema:
type: string
- description: x-api-key
in: header
name: x-api-key
required: true
schema:
type: string
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/v2.ListFirewallsAPIOutput'
description: OK
'400':
content:
application/json:
schema:
$ref: '#/components/schemas/v2.ListFirewallsAPIOutput'
description: Bad Request
summary: List V2 firewalls
tags:
- ManageNGFW-V2
post:
description: 'Create a new Cloud NGFW resource using V2 API.
'
operationId: post-v2-ngfirewalls-v2
parameters:
- description: FW region
in: query
name: region
required: true
schema:
type: string
- description: Authorization
in: header
name: Authorization
required: true
schema:
type: string
- description: x-api-key
in: header
name: x-api-key
required: true
schema:
type: string
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/v2.CreateFirewallAPIInput'
required: true
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/v2.CreateFirewallAPIOutput'
description: OK
'400':
content:
application/json:
schema:
$ref: '#/components/schemas/v2.CreateFirewallAPIOutput'
description: Bad Request
summary: Create V2 firewall
tags:
- ManageNGFW-V2
/v2/ngfirewalls/:
get:
description: 'List V1 firewalls using V2 endpoint.
'
operationId: get-v2-ngfirewalls-v1
parameters:
- description: FW region
in: query
name: region
required: true
schema:
type: string
- description: v1 route
in: query
name: v1route
required: true
schema:
type: string
- description: Authorization
in: header
name: Authorization
required: true
schema:
type: string
- description: x-api-key
in: header
name: x-api-key
required: true
schema:
type: string
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/v1.ListFirewallsAPIOutput'
description: OK
'400':
content:
application/json:
schema:
$ref: '#/components/schemas/v1.ListFirewallsAPIOutput'
description: Bad Request
summary: List V1 firewalls
tags:
- ManageNGFW-V2
post:
description: 'Create V1 firewalls using V2 endpoint.
'
operationId: post-v2-ngfirewalls-v1
parameters:
- description: FW region
in: query
name: region
required: true
schema:
type: string
- description: v1 route
in: query
name: v1route
required: true
schema:
type: boolean
- description: Authorization
in: header
name: Authorization
required: true
schema:
type: string
- description: x-api-key
in: header
name: x-api-key
required: true
schema:
type: string
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/v1.CreateFirewallAPIInput'
required: true
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/v1.CreateFirewallAPIOutput'
description: OK
'400':
content:
application/json:
schema:
$ref: '#/components/schemas/v1.CreateFirewallAPIOutput'
description: Bad Request
summary: Create V1 firewall
tags:
- ManageNGFW-V2
/v2/ngfirewalls/{firewall_id}:
delete:
description: 'Delete a specific firewall by firewall ID.
'
operationId: delete-v2-ngfirewalls-firewall_id
parameters:
- description: FW region
in: query
name: region
required: true
schema:
type: string
- description: 'The unique identifier of the firewall.
'
in: path
name: firewall_id
required: true
schema:
type: string
- description: Authorization
in: header
name: Authorization
required: true
schema:
type: string
- description: x-api-key
in: header
name: x-api-key
required: true
schema:
type: string
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/v2.DeleteFirewallAPIOutput'
description: OK
'400':
content:
application/json:
schema:
$ref: '#/components/schemas/v2.DeleteFirewallAPIOutput'
description: Bad Request
summary: Delete firewall by ID
tags:
- ManageNGFW-V2
get:
description: 'Retrieve details of a specific firewall by firewall ID.
'
operationId: get-v2-ngfirewalls-firewall_id
parameters:
- description: FW region
in: query
name: region
required: true
schema:
type: string
- description: 'The unique identifier of the firewall.
'
in: path
name: firewall_id
required: true
schema:
type: string
- description: Authorization
in: header
name: Authorization
required: true
schema:
type: string
- description: x-api-key
in: header
name: x-api-key
required: true
schema:
type: string
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/v2.ReadFirewallAPIOutput'
description: OK
'400':
content:
application/json:
schema:
$ref: '#/components/schemas/v2.ReadFirewallAPIOutput'
description: Bad Request
summary: Retrieve firewall by ID
tags:
- ManageNGFW-V2
patch:
description: update ngfirewall
operationId: patch-v2-ngfirewalls-firewall_id
parameters:
- description: FW region
in: query
name: region
required: true
schema:
type: string
- description: Firewall ID
in: path
name: firewall_id
required: true
schema:
type: string
- description: Authorization
in: header
name: Authorization
required: true
schema:
type: string
- description: x-api-key
in: header
name: x-api-key
required: true
schema:
type: string
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/v2.UpdateFirewallAPIInput'
required: true
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/v2.UpdateFirewallAPIOutput'
description: OK
'400':
content:
application/json:
schema:
$ref: '#/components/schemas/v2.UpdateFirewallAPIOutput'
description: Bad Request
summary: update ngfirewall
tags:
- ManageNGFW-V2
/v2/ngfirewalls/{firewall_id}/link:
delete:
description: disassociate fw link
operationId: delete-v2-ngfirewalls-firewall_id-link
parameters:
- description: FW region
in: query
name: region
required: true
schema:
type: string
- description: Firewall ID
in: path
name: firewall_id
required: true
schema:
type: string
- description: Authorization
in: header
name: Authorization
required: true
schema:
type: string
- description: x-api-key
in: header
name: x-api-key
required: true
schema:
type: string
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/v2.DisassociateLinkInput'
required: true
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/v2.DisassociateLinkOutput'
description: OK
'400':
content:
application/json:
schema:
$ref: '#/components/schemas/v2.DisassociateLinkOutput'
description: Bad Request
summary: disassociate fw link
tags:
- ManageNGFW-V2
post:
description: associate fw link
operationId: post-v2-ngfirewalls-firewall_id-link
parameters:
- description: FW region
in: query
name: region
required: true
schema:
type: string
- description: Firewall ID
in: path
name: firewall_id
required: true
schema:
type: string
- description: Authorization
in: header
name: Authorization
required: true
schema:
type: string
- description: x-api-key
in: header
name: x-api-key
required: true
schema:
type: string
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/v2.AssociateLinkInput'
required: true
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/v2.AssociateLinkOutput'
description: OK
'400':
content:
application/json:
schema:
$ref: '#/components/schemas/v2.AssociateLinkOutput'
description: Bad Request
summary: associate fw link
tags:
- ManageNGFW-V2
/v2/ngfirewalls/{firewall_id}/logprofile:
get:
description: read logprofile
operationId: get-v2-ngfirewalls-firewall_id-logprofile
parameters:
- description: FW region
in: query
name: region
required: true
schema:
type: string
- description: Firewall ID
in: path
name: firewall_id
required: true
schema:
type: string
- description: Authorization
in: header
name: Authorization
required: true
schema:
type: string
- description: x-api-key
in: header
name: x-api-key
required: true
schema:
type: string
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/v2.ReadLogProfileInput'
required: true
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/v2.ReadLogProfileOutput'
description: OK
'400':
content:
application/json:
schema:
$ref: '#/components/schemas/v2.ReadLogProfileOutput'
description: Bad Request
summary: read logprofile
tags:
- ManageNGFW-V2
post:
description: update logprofile
operationId: post-v2-ngfirewalls-firewall_id-logprofile
parameters:
- description: FW region
in: query
name: region
required: true
schema:
type: string
- description: Firewall ID
in: path
name: firewall_id
required: true
schema:
type: string
- description: Authorization
in: header
name: Authorization
required: true
schema:
type: string
- description: x-api-key
in: header
name: x-api-key
required: true
schema:
type: string
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/v2.UpdateLogProfileInput'
required: true
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/v2.UpdateLogProfileOutput'
description: OK
'400':
content:
application/json:
schema:
$ref: '#/components/schemas/v2.UpdateLogProfileOutput'
description: Bad Request
summary: update logprofile
tags:
- ManageNGFW-V2
/v2/ngfirewalls/{firewall_id}/rulestack:
delete:
description: disassociate rulestack
operationId: delete-v2-ngfirewalls-firewall_id-rulestack
parameters:
- description: FW region
in: query
name: region
required: true
schema:
type: string
- description: Firewall ID
in: path
name: firewall_id
required: true
schema:
type: string
- description: Authorization
in: header
name: Authorization
required: true
schema:
type: string
- description: x-api-key
in: header
name: x-api-key
required: true
schema:
type: string
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/v2.DisassociateRuleStackInput'
required: true
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/v2.DisassociateRuleStackOutput'
description: OK
'400':
content:
application/json:
schema:
$ref: '#/components/schemas/v2.DisassociateRuleStackOutput'
description: Bad Request
summary: disassociate rulestack
tags:
- ManageNGFW-V2
post:
description: associate rulestack
operationId: post-v2-ngfirewalls-firewall_id-rulestack
parameters:
- description: FW region
in: query
name: region
required: true
schema:
type: string
- description: Firewall ID
in: path
name: firewall_id
required: true
schema:
type: string
- description: Authorization
in: header
name: Authorization
required: true
schema:
type: string
- description: x-api-key
in: header
name: x-api-key
required: true
schema:
type: string
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/v2.AssociateRuleStackInput'
required: true
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/v2.AssociateRuleStackOutput'
description: OK
'400':
content:
application/json:
schema:
$ref: '#/components/schemas/v2.AssociateRuleStackOutput'
description: Bad Request
summary: associate rulestack
tags:
- ManageNGFW-V2
/v2/ngfirewalls/{firewall_name}:
delete:
description: v1 delete firewall
operationId: delete-v2-ngfirewalls-firewall_name
parameters:
- description: FW region
in: query
name: region
required: true
schema:
type: string
- description: v1 route
in: query
name: v1route
required: true
schema:
type: boolean
- description: Authorization
in: header
name: Authorization
required: true
schema:
type: string
- description: x-api-key
in: header
name: x-api-key
required: true
schema:
type: string
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/v1.DeleteFirewallAPIOutput'
description: OK
'400':
content:
application/json:
schema:
$ref: '#/components/schemas/v1.DeleteFirewallAPIOutput'
description: Bad Request
summary: v1 delete firewall
tags:
- ManageNGFW-V2
get:
description: 'Retrieve details of a specific firewall by firewall name.
'
operationId: get-v2-ngfirewalls-firewall_name
parameters:
- description: FW region
in: query
name: region
required: true
schema:
type: string
- description: v1 route
in: query
name: v1route
required: true
schema:
type: boolean
- description: Authorization
in: header
name: Authorization
required: true
schema:
type: string
- description: x-api-key
in: header
name: x-api-key
required: true
schema:
type: string
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/v1.ReadFirewallAPIOutput'
description: OK
'400':
content:
application/json:
schema:
$ref: '#/components/schemas/v1.ReadFirewallAPIOutput'
description: Bad Request
summary: Retrieve firewall by name
tags:
- ManageNGFW-V2
/v2/ngfirewalls/{firewall_name}/contentversion:
put:
description: 'Update the content version for a firewall by firewall name.
'
operationId: put-v2-ngfirewalls-firewall_name-contentversion
parameters:
- description: FW region
in: query
name: region
required: true
schema:
type: string
- description: v1 route
in: query
name: v1route
required: true
schema:
type: string
- description: Authorization
in: header
name: Authorization
required: true
schema:
type: string
- description: x-api-key
in: header
name: x-api-key
required: true
schema:
type: string
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/v1.UpdateContentVersionAPIInput'
required: true
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/v1.UpdateContentVersionAPIOutput'
description: OK
'400':
content:
application/json:
schema:
$ref: '#/components/schemas/v1.UpdateContentVersionAPIOutput'
description: Bad Request
summary: Update firewall content version
tags:
- ManageNGFW-V2
/v2/ngfirewalls/{firewall_name}/description:
put:
description: 'Update the description of a firewall by firewall name.
'
operationId: put-v2-ngfirewalls-firewall_name-description
parameters:
- description: FW region
in: query
name: region
required: true
schema:
type: string
- description: v1 route
in: query
name: v1route
required: true
schema:
type: boolean
- description: Authorization
in: header
name: Authorization
required: true
schema:
type: string
- description: x-api-key
in: header
name: x-api-key
required: true
schema:
type: string
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/v1.UpdateDescriptionAPIInput'
required: true
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/v1.UpdateDescriptionAPIOutput'
description: OK
'400':
content:
application/json:
schema:
$ref: '#/components/schemas/v1.UpdateDescriptionAPIOutput'
description: Bad Request
summary: Update firewall description
tags:
- ManageNGFW-V2
/v2/ngfirewalls/{firewall_name}/features:
put:
description: 'Configure firewall features by firewall name.
'
operationId: put-v2-ngfirewalls-firewall_name-features
parameters:
- description: FW region
in: query
name: region
required: true
schema:
type: string
- description: v1 route
in: query
name: v1route
required: true
schema:
type: boolean
- description: Authorization
in: header
name: Authorization
required: true
schema:
type: string
- description: x-api-key
in: header
name: x-api-key
required: true
schema:
type: string
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/v1.UpdateFeaturesAPIInput'
required: true
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/v1.UpdateFeaturesAPIOutput'
description: OK
'400':
content:
application/json:
schema:
$ref: '#/components/schemas/v1.UpdateFeaturesAPIOutput'
description: Bad Request
summary: Configure firewall features
tags:
- ManageNGFW-V2
/v2/ngfirewalls/{firewall_name}/logprofile:
get:
description: v1 read logprofile
operationId: get-v2-ngfirewalls-firewall_name-logprofile
parameters:
- description: FW region
in: query
name: region
required: true
schema:
type: string
- description: account id
in: query
name: accountid
required: true
schema:
type: string
- description: v1 route
in: query
name: v1route
required: true
schema:
type: string
- description: Authorization
in: header
name: Authorization
required: true
schema:
type: string
- description: x-api-key
in: header
name: x-api-key
required: true
schema:
type: string
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/v1.ReadLogProfileAPIInput'
required: true
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/v1.ReadLogProfileAPIOutput'
description: OK
'400':
content:
application/json:
schema:
$ref: '#/components/schemas/v1.ReadLogProfileAPIOutput'
description: Bad Request
summary: v1 read logprofile
tags:
- ManageNGFW-V2
post:
description: v1 update logprofile
operationId: post-v2-ngfirewalls-firewall_name-logprofile
parameters:
- description: FW region
in: query
name: region
required: true
schema:
type: string
- description: v1 route
in: query
name: v1route
required: true
schema:
type: string
- description: Authorization
in: header
name: Authorization
required: true
schema:
type: string
- description: x-api-key
in: header
name: x-api-key
required: true
schema:
type: string
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/v1.UpdateLogProfileAPIInput'
required: true
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/v1.UpdateLogProfileAPIOutput'
description: OK
'400':
content:
application/json:
schema:
$ref: '#/components/schemas/v1.UpdateLogProfileAPIOutput'
description: Bad Request
summary: v1 update logprofile
tags:
- ManageNGFW-V2
/v2/ngfirewalls/{firewall_name}/rulestack:
post:
description: v1 associate rulestack
operationId: post-v2-ngfirewalls-firewall_name-rulestack
parameters:
- description: FW region
in: query
name: region
required: true
schema:
type: string
- description: v1 route
in: query
name: v1route
required: true
schema:
type: string
- description: Authorization
in: header
name: Authorization
required: true
schema:
type: string
- description: x-api-key
in: header
name: x-api-key
required: true
schema:
type: string
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/v1.AssociateRuleStackAPIInput'
required: true
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/v1.AssociateRuleStackAPIOutput'
description: OK
'400':
content:
application/json:
schema:
$ref: '#/components/schemas/v1.AssociateRuleStackAPIOutput'
description: Bad Request
summary: v1 associate rulestack
tags:
- ManageNGFW-V2
/v2/ngfirewalls/{firewall_name}/subnets:
post:
description: v1 update subnet mappings
operationId: post-v2-ngfirewalls-firewall_name-subnets
parameters:
- description: FW region
in: query
name: region
required: true
schema:
type: string
- description: v1 route
in: query
name: v1route
required: true
# --- truncated at 32 KB (83 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/palo-alto-networks/refs/heads/main/openapi/palo-alto-networks-managengfw-v2-api-openapi.yml