: Create a Deployment Profile Using the Licensing API
Focus
Focus

Create a Deployment Profile Using the Licensing API

Table of Contents

Create a Deployment Profile Using the Licensing API

Use the following API to create a new deployment profile to license your VM-Series and CN-Series firewalls use Software NGFW credits.
Header Parameters
:
token
Request Body Parameters
:
creditPoolId
,
name
,
type
,
panOs
,
firewallQuantity
,
vCpuQuantity
,
panorama
, and
subs
Request Method
: POST
URL
:
https://api.paloaltonetworks.com/tms/v1/deploymentProfile
Use the following API to create a new deployment profile to license your VM-Series and CN-Series firewalls using Software NGFW credits. The API response returns the Software NGFW auth code that your will use to license your firewalls.
Parameter
Description
creditPoolId
This parameter is required.
This deployment profile is added to the credit pool with the ID number you enter here.
name
The deployment profile name.
type
This parameter is required.
For VM-Series, enter
vm
.
panOs
For flexible vCPU VM-Series firewalls, enter
10.0.4_or_above
.
For fixed model VM-Series firewalls, enter
10.0.3_or-below
firewallQuantity
This parameter is required.
The number of firewalls. This value must be greater than zero (0).
vCpuQuantity
The number of planned vCPUs per firewall.
This is required if
type
is set VM-Flex. Additionally, the vCPU value must be greater than zero (0) and less than or equal to 64.
vmModel
This parameter is required when creating a deployment profile for fixed model VM-Series firewalls.
  • For VM-50, enter
    50
    .
  • For VM-100, enter
    100
    .
  • For VM-300, enter
    300
    .
  • For VM-500, enter
    500
    .
  • For VM-700, enter
    700
    .
panorama
This parameter allows you to use Software NGFW credits to enable Panorama. Use
PAN
to enable Panorama or
DLC
to enable Panorama as a Dedicated Log Collector.
subscriptions
Specify subscriptions to add to your deployment profile. You can enter multiple subscriptions with some limitations.
  • Threat Prevention (TP)
  • Advanced Threat Protection (ATP)
  • URL Filtering (URL4)
  • Advanced URL Filtering (AURL)
  • DNS (DNS)
  • Global Protect (GP)
  • DLP (DLP)
  • Wildfire (WF)
  • Advanced Wildfire (AWF)
  • SD-WAN (SDWAN)
  • Intelligent Traffic Offload (ITO)
  • Web Proxy (WP)
If
panOsVersion
is left blank, this field is required.
Sample API request
:
curl --location --request POST 'https://api.paloaltonetworks.com/tms/v1/deploymentProfile' \ --header 'token: <your-token>' \ --header 'Content-Type: application/json' \ --data-raw '{ "creditPoolId": 97101#####, "name":"3-16-1", "type": "VM", "panOS": "10.0.4_or-above", "firewallQuantity": 1, "vCpuQuantity": 2, "panorama": [ "Management", "LogCollector" ], "subscriptions": [ "DNS", "GP", "DLP" ] }'
Sample API response
:
{ "profileId": 29###, "authCode": "D#######", "success": true, "message": "Deployment profile saved successfully." }
The response returns the full authcode.

Recommended For You