: Manage Deployment Profiles Using the Licensing API
Focus
Focus

Manage Deployment Profiles Using the Licensing API

Table of Contents

Manage Deployment Profiles Using the Licensing API

Use the following APIs to retrieve a deployment profile, view deployment profile information, or delete a deployment profile.
Use the following APIs to retrieve information about an existing deployment profile or to delete a deployment profile you are no longer using.

Get All Credit Pools

Use this API to retrieve information about all credit pools associated with your CSP account.
Header Parameters: token
Request Method: GET
URL: https://api.paloaltonetworks.com/tms/v1/creditPool
Sample API request:
curl --location --request GET 'https://api.paloaltonetworks.com/tms/v1/creditPool' \ --header 'token: <your-token>'
Sample API response:
{ "data": [ { "creditPoolId": 31586#####, "poolName": "Software NGFW Credits", "supportType": "Platinum", "expirationDate": "02/07/2026", "totalCredits": 27.84, "creditsAllocated": 0.0, "creditsConsumed": 0.0, "creditsAvailable": 27.84 }, { "creditPoolId": 99394#####, "poolName": "Software NGFW Credits", "supportType": "Premium", "expirationDate": "10/27/2023", "totalCredits": 47.0, "creditsAllocated": 13.68, "creditsConsumed": 0.0, "creditsAvailable": 33.32 }, { "creditPoolId": 90775#####, "poolName": "Software NGFW Credits", "supportType": "Premium Partner", "expirationDate": "04/13/2025", "totalCredits": 34.0, "creditsAllocated": 0.0, "creditsConsumed": 0.0, "creditsAvailable": 34.0 } ] }

Get a Credit Pool by Credit Pool ID

Header Parameters: token
Path Parameters: creditPoolId
Request Method: GET
URL: https://api.paloaltonetworks.com/tms/v1/creditPool/{creditPoolId}
Sample API request:
curl --location --request GET 'https://api.paloaltonetworks.com/tms/v1/creditPool/<creditPoolId>' \ --header 'token: <your-token>'
Sample API response:
{ "data": { "creditPoolId": 97101#####, "poolName": "Software NGFW Credits", "supportType": "Premium", "expirationDate": "02/20/2026", "totalCredits": 194.0, "creditsAllocated": 172.75, "creditsConsumed": 43.94, "creditsAvailable": 21.25 } }

Get All Deployment Profiles in a Credit Pool

Use this API to get the details of a specific deployment profile.
Header Parameters: token
Path Parameters: creditPoolId
Request Method: GET
URL: https://api.paloaltonetworks.com/tms/v1/creditPool/{creditPoolId}/deploymentProfile
Sample API request:
curl --location --request GET 'https://api.paloaltonetworks.com/tms/v1/creditPool/<creditPoolId>/deploymentProfile' \ --header 'token:<your-token>'
Sample API response:
{ "data": [ { "profileName": "Credit Pool 1", "dAuthCode": "D#######", "type": "VM", "panOsVersion": "10.0.4_or-above", "creditsAllocated": 41.860000610351562, "creditsConsumed": 20.930000305175781, "vCpuConsumed": 2, "vCpuAllocated": 4, "fWsDeployed": 1, "fWsPlanned": 2, "status": "Updated" }, { "profileName": "Credit Pool 2", "dAuthCode": "D#######", "type": "VM", "panOsVersion": "10.0.3_or-below", "creditsAllocated": 32.200000762939453, "creditsConsumed": 0.0, "vCpuConsumed": 0, "vCpuAllocated": 4, "fWsDeployed": 0, "fWsPlanned": 2, "status": "Created" } ] }

Get a Deployment Profile

Use this API to get the details of a specific deployment profile.
Header Parameters: token
Path Parameters: authCode
Request Method: GET
URL: https://api.paloaltonetworks.com/tms/v1/deploymentProfile/{authCode}
Sample API request:
curl --location --request GET 'https://api.paloaltonetworks.com/tms/v1/deploymentProfile/<authCode>' \ --header 'token:<your-token>'
Sample API response:
{ "data": { "profileName": "deployment-profile-1", "dAuthCode": "D#######", "type": "VM", "panOsVersion": "10.0.3_or-below", "creditsAllocated": 43.7, "creditsConsumed": 0.0, "vCpuConsumed": 0, "vCpuAllocated": 8, "fWsDeployed": 0, "fWsPlanned": 1, "status": "Updated" } } }

Delete a Deployment Profile

Use this API to delete a specific deployment profile.
Header Parameters: token
Path Parameters: authCode
Request Method: DELETE
URL: https://api.paloaltonetworks.com/v1/deployment-profile/auth-code/{auth-code}
Sample API request:
curl --location --request DELETE 'https://api.paloaltonetworks.com//tms/v1/deploymentProfile/<authCode>' \ --header 'token:<your-token>'
Sample API response:
{ "isDeleted": true, "dAuthcode": "D#######", "message": "Deleted" }