Software NGFW Licensing API
Focus
Focus
VM-Series

Software NGFW Licensing API

Table of Contents

Software NGFW Licensing API

Learn how to use the API to license your VM-Series firewalls with Software NGFW credits.
Where Can I Use This?What Do I Need?
  • VM-Series deployment
  • VM-Series 10.x or above
  • Panorama running PAN-OS 10.1.x or above versions
  • Customer Support Portal (CSP) account with one of the following user roles:
    • Super User, Standard User, Limited User, Threat Researcher, AutoFocus Trial Role, Group Super User, Group Standard User, Group Limited User, Group Threat Researcher, Authorized Support Center (ASC) User, and ASC Full Service User.
    • Superuser access to the VM-Series firewall
Use the Software NGFW licensing API to create and manage credit pools auth codes, retrieve the credit pool attached to an auth code, all model-based licenses on a VM-Series firewall. In addition, the licensing API enables you to license firewalls that do not have direct internet access and cannot reach the Palo Alto Networks license server. You can manage licenses manually or automate licensing with a custom script or an orchestration service.
To use the API, each support account is assigned a unique client ID and client secret. You will use the client ID and client secret associated with your customer support account to generate an access token. Each API call must include the access token to authenticate the request to the licensing server. When authenticated, the licensing server sends the response in json format (content-type application/json). Contact your Palo Alto Networks sales representative to get your client ID and client secret.

Generate Your OAuth Client Credentials

Palo Alto Networks uses OAuth 2.0 to limit access to the Software NGFW Credit AP. To use Software NGFW Credit API to manage your deployment profiles, you must first generate OAuth credentials–client ID and secret key–on the Palo Alto Networks CSP. The client ID and secret key are required to make API calls to the Palo Alto Networks licensing server.
If the option to generate the client credentials does not appear in the CSP, contact your sales representative.
  1. Log in to the CSP.
  2. Select Account ManagementOAuth API Management.
  3. Select the fwflex-service scope.
  4. Click Create OAuth Credentials.
  5. Copy your Client ID and Secret Key. Save your secret key in a safe place. You will not be able to retrieve the secret key again.

Get Serial Numbers Associated with an Authcode Using the API

Header Parameters: token
Query Parameters: auth_code
Request Method: GET
URL: https://api.paloaltonetworks.com/tms/v1/firewallserialnumbers?auth_code=<authcode>
Use the following API to retrieve a list of serial numbers associated with a specified auth code.
Sample API request:
curl --location --request GET 'https://api.paloaltonetworks.com/tms/v1/firewallserialnumbers?auth_code=<authcode>'\ --header 'token: <your-token>' \
Sample API response:
{ "vm_series": [ "00799##########" ], "cn_panorama": [], "panorama": [], "cn_firewall": [] }

Deactivate a VM-Series Firewall Using the API

Header Parameters: token
Query Parameters: auth_code, serial_numbers
Request Method: DELETE
URL: https://api.paloaltonetworks.com/tms/v1/firewall/deactivate
Use the following API to delete one or more firewall resources associated with a specified auth code. To delete multiple firewall resources, insert each serial number separated by commas.
Sample API request:
curl --location --request DELETE 'https://api.paloaltonetworks.com/tms/v1/firewall/deactivate?auth_code=<authcode>&serial_numbers=<serialnumber>,<serialnumber>'\ --header 'token: <your-token>' \
Sample API response:
{ "success": ["00799##########","00799##########" ], "failed": [], "auth_code": "D#######", "failure_reason": [] }