>
    Strata Copilot
    Create a Deployment Profile Using the Licensing API
    Focus
    Download PDF
    Focus
    1. Home
    2. VM-Series
    3. Software NGFW Credits
    4. Software NGFW Licensing API
    5. Create a Deployment Profile Using the Licensing API
    Download PDF
    VM-Series

    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.
    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
    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.
    For CN-Series, enter cn.
    panOs
    The PAN-OS version is specific to the firewall type—VM-Series or CN-Series.
    VM-Series—
    • For flexible vCPU VM-Series firewalls, enter 10.0.4_or_above
    • For fixed model VM-Series firewalls, enter 10.0.3_or-below
    For CN-Series, enter 10.0,10.1_and-above,10.2
    firewallQuantity
    This parameter is required.
    The number of firewalls. This value must be greater than zero (0).
    This isn’t required for CN-Series running PAN-OS 10.1 and above or PAN-OS 10.2.
    vCpuQuantity
    The number of planned vCPUs per firewall.
    This is required if type is set VM-Flex (any PAN-OS version) or CN-Series running PAN-OS 10.1 and above or PAN-OS 10.2. Additionally, the vCPU value must be greater than zero (0) and less than or equal to 64.
    vSysQuantity
    		The number of virtual systems (vsys) available on each firewall deployed with this auth code. The default value is 1 and only positive integers are allowed.
    This parameter is optional.
    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 Management to enable Panorama or LogCollector to enable Panorama as a Dedicated Log Collector. This parameter accepts a list of stings.
    The parameters are case-sensitive.
    subscriptions
    Specify subscriptions to add to your deployment profile. This parameter accepts a list of strings The subscriptions are PAN-OS specific.
    For PAN-OS 10.0.3 and below (fixed vCPU models) and PAN-OS 10.0.4 and above (flexible vCPUs)
    • Advanced URL Filtering (AURL)
    • DNS (DNS)
    • Global Protect (GP)
    • DLP (DLP)
    • SD-WAN (SDWAN)
    • Intelligent Traffic Offload (ITO)
    • Advanced Threat Protection (ATP)
    • Web Proxy (WP)
    • Advanced Wildfire (AWF)
    • Network Packet Broker (DPB)
    • Decryption Port Mirror (DPM)
    • AIOps (AIOPS)
    • SaaS Security Inline (SAASINLINE)
    • Advanced DNS (ADNS)
    If panOsVersion is left blank, this field is required.
    Specify subscriptions to add to your deployment profile. This parameter accepts a list of strings The subscriptions are PAN-OS specific.
    For CN-Series running PAN-OS 10.0:
    • Threat Prevention (TP)
    • Advanced URL Filtering (AURL)
    • DNS (DNS)
    • Global Protect (GP)
    • DLP (DLP)
    • Wildfire (WF)
    • SD-WAN (SDWAN)
    • URL Filtering (URL4)
    • Advanced Wildfire (AWF)
    • Network Packet Broker (DPB)
    • Decryption Port Mirror (DPM)
    • Advanced DNS (ADNS)
    If panOsVersion is left blank, this field is required.
    Specify subscriptions to add to your deployment profile. This parameter accepts a list of strings The subscriptions are PAN-OS specific.
    For CN-Series running PAN-OS 10.1 and above:
    • Threat Prevention (TP)
    • DNS (DNS)
    • Wildfire (WF)
    • Intelligent Traffic Offload (ITO)
    • URL Filtering (URL4)
    • Network Packet Broker (DPB)
    • Decryption Port Mirror (DPM)
    • Advanced DNS (ADNS)
    If panOsVersion is left blank, this field is required.
    Specify subscriptions to add to your deployment profile. This parameter accepts a list of strings The subscriptions are PAN-OS specific.
    For CN-Series running PAN-OS 10.2.0 and above:
    • Threat Prevention (TP)
    • Advanced URL Filtering (AURL)
    • DNS (DNS)
    • Wildfire (WF)
    • Intelligent Traffic Offload (ITO)
    • Hyperscale Security Fabric (HSF)
    • Network Packet Broker (DPB)
    • Decryption Port Mirror (DPM)
    • Advanced DNS (ADNS)
    If panOsVersion is left blank, this field is required.
    features
    Specify use of Network Packet Broker and Decryption Port Mirror.
    • Network Packet Broker (DPB)
    • Decryption Port Mirror (DPM)
    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":"sample DP",
    "type": "VM",
    "panOS": "10.0.4_or-above",
    "firewallQuantity": 1,
    "vSysQuantity": 1,
    "vCpuQuantity": 2,
    "panorama": [
        "Management",
    ],
    "subscriptions": [
        "DNS",
    ] 
}'
    Sample API response:
    {
    "profile_id": 29###,
    "auth_code": "D#######",
    "success": true,
    "message": "Deployment profile saved successfully."
}
    The response returns the full auth code.

    © 2026 Palo Alto Networks, Inc. All rights reserved.