Palo Alto Networks · OpenAPI Overlay 1.0.0
API Evangelist conversational phrasing for Palo Alto Networks Licensing API
12 actions
12 updates
phrasing
extends
openapi/palo-alto-networks-licensing-api-openapi.yml
Generated by API Evangelist
Written by API Evangelist tooling for Palo Alto Networks's API. It is a proposal applied on top of the contract, not a document Palo Alto Networks publishes.
What the actions change
x-apievangelist-phrasing
Targets 12
$.info
$.paths['/license/api/v1/usage'].post
$.paths['/license/api/v1/usage/time_series'].post
$.paths['/license/api/v2/usage'].post
$.paths['/license/api/v2/time_series'].post
$.paths['/license/api/v1/credit-allocation-rules'].post
$.paths['/license/api/v1/credit-allocation-rule'].post
$.paths['/license/api/v1/credit-allocation-rule-summary'].post
$.paths['/license/api/v1/credit-allocation-rule/{ruleId}'].get
$.paths['/license/api/v1/credit-allocation-rule/{ruleId}'].delete
$.paths['/license/api/v1/credit-allocation-rule/{ruleId}'].patch
$.paths['/license/api/v1/credit-allocation-rule-names'].get
OpenAPI Overlay
# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
title: API Evangelist conversational phrasing for Palo Alto Networks Licensing API
version: 1.0.0
extends: openapi/palo-alto-networks-licensing-api-openapi.yml
actions:
- target: $.info
update:
x-apievangelist-phrasing:
method: generated
generated: '2026-09-26'
generator: build-phrasing.py
label: Generated by API Evangelist
operations: 11
- target: $.paths['/license/api/v1/usage'].post
update:
x-apievangelist-phrasing:
intent: Count resource usage for one cloud (v1, deprecated)
effect: read
questions:
- How do I get per-account resource usage for a single cloud with the older v1 licensing API?
- Is the v1 usage-count-by-cloud endpoint deprecated?
instructions:
- text: Using deprecated v1, count usage for {cloud_type} accounts {accountIds} over {timeRange}.
slots:
cloud_type: query.cloud_type
accountIds: requestBody.accountIds
timeRange: requestBody.timeRange
- text: Get v1 per-account license usage in {cloud_type} for {accountIds} during {timeRange}.
slots:
cloud_type: query.cloud_type
accountIds: requestBody.accountIds
timeRange: requestBody.timeRange
method: generated
generated: '2026-09-26'
- target: $.paths['/license/api/v1/usage/time_series'].post
update:
x-apievangelist-phrasing:
intent: Chart resource usage over time (v1, deprecated)
effect: read
questions:
- Can the deprecated v1 licensing API show resource usage trends over time?
- Which time-series usage endpoint is scheduled to be retired?
instructions:
- text: Using deprecated v1, chart usage over time for accounts {accountIds} in {timeRange}.
slots:
accountIds: requestBody.accountIds
timeRange: requestBody.timeRange
- text: Get the v1 usage time series for {accountIds} across {timeRange}.
slots:
accountIds: requestBody.accountIds
timeRange: requestBody.timeRange
method: generated
generated: '2026-09-26'
- target: $.paths['/license/api/v2/usage'].post
update:
x-apievangelist-phrasing:
intent: Count resource usage per account by cloud (v2)
effect: read
questions:
- How many licensed resources is each account using across several cloud types?
- Can I page through per-account resource usage with a page token?
instructions:
- text: Count v2 resource usage for accounts {accountIds} over {timeRange}.
slots:
accountIds: requestBody.accountIds
timeRange: requestBody.timeRange
- text: Break down usage for {accountIds} in clouds {cloudTypes} during {timeRange}.
slots:
accountIds: requestBody.accountIds
cloudTypes: requestBody.cloudTypes
timeRange: requestBody.timeRange
method: generated
generated: '2026-09-26'
- target: $.paths['/license/api/v2/time_series'].post
update:
x-apievangelist-phrasing:
intent: Chart resource usage over time (v2)
effect: read
questions:
- How has our licensed resource usage trended over the past quarter?
- Can I see usage over time filtered to specific cloud types?
instructions:
- text: Show the v2 usage trend for accounts {accountIds} over {timeRange}.
slots:
accountIds: requestBody.accountIds
timeRange: requestBody.timeRange
- text: Chart usage over time for {accountIds} in {cloudTypes} during {timeRange}.
slots:
accountIds: requestBody.accountIds
cloudTypes: requestBody.cloudTypes
timeRange: requestBody.timeRange
method: generated
generated: '2026-09-26'
- target: $.paths['/license/api/v1/credit-allocation-rules'].post
update:
x-apievangelist-phrasing:
intent: List credit allocation rules with usage
effect: read
questions:
- How many credits has each allocation rule used so far?
- Which credit allocation rules are over their alarm threshold?
instructions:
- text: List credit allocation rules and usage for {timeRange}.
slots:
timeRange: requestBody.timeRange
- text: Show usage for credit allocation rules {ruleNames}.
slots:
ruleNames: requestBody.ruleNames
method: generated
generated: '2026-09-26'
- target: $.paths['/license/api/v1/credit-allocation-rule'].post
update:
x-apievangelist-phrasing:
intent: Create a credit allocation rule
effect: write
questions:
- How do I allocate a budget of credits to specific account groups?
- Can I set an alarm threshold when credits for a group run low?
instructions:
- text: Create credit rule {id} named {name} targeting {targetType} with {allocatedCredits} credits, alarm at {alarmThreshold}, for groups {accountGroups}.
slots:
id: requestBody.id
name: requestBody.name
targetType: requestBody.targetType
allocatedCredits: requestBody.allocatedCredits
alarmThreshold: requestBody.alarmThreshold
accountGroups: requestBody.accountGroups
- text: Allocate {allocatedCredits} credits to {accountGroups} under new rule {name} ({id}, {targetType}, alarm {alarmThreshold}).
slots:
allocatedCredits: requestBody.allocatedCredits
accountGroups: requestBody.accountGroups
name: requestBody.name
id: requestBody.id
targetType: requestBody.targetType
alarmThreshold: requestBody.alarmThreshold
method: generated
generated: '2026-09-26'
- target: $.paths['/license/api/v1/credit-allocation-rule-summary'].post
update:
x-apievangelist-phrasing:
intent: Summarize credit allocation rules
effect: read
questions:
- What's the overall summary of credit allocation across all rules?
- How are allocated credits tracking in aggregate this month?
instructions:
- text: Summarize credit allocation rules for {timeRange}.
slots:
timeRange: requestBody.timeRange
- text: Give me the credit allocation rule summary.
method: generated
generated: '2026-09-26'
- target: $.paths['/license/api/v1/credit-allocation-rule/{ruleId}'].get
update:
x-apievangelist-phrasing:
intent: Get a credit allocation rule
effect: read
questions:
- How is a single credit allocation rule configured?
- Can I view one allocation rule's settings without its usage numbers?
instructions:
- text: Get credit allocation rule {ruleId}.
slots:
ruleId: path.ruleId
- text: Show the configuration of allocation rule {ruleId}.
slots:
ruleId: path.ruleId
method: generated
generated: '2026-09-26'
- target: $.paths['/license/api/v1/credit-allocation-rule/{ruleId}'].delete
update:
x-apievangelist-phrasing:
intent: Delete a credit allocation rule
effect: destructive
questions:
- How do I remove a credit allocation rule?
- Can I delete an allocation rule that's no longer needed?
instructions:
- text: Delete credit allocation rule {ruleId}.
slots:
ruleId: path.ruleId
- text: Remove allocation rule {ruleId} permanently.
slots:
ruleId: path.ruleId
method: generated
generated: '2026-09-26'
- target: $.paths['/license/api/v1/credit-allocation-rule/{ruleId}'].patch
update:
x-apievangelist-phrasing:
intent: Update a credit allocation rule
effect: write
questions:
- Can I raise the credits allocated under an existing rule?
- How do I change the alarm threshold on a credit allocation rule?
instructions:
- text: 'Update rule {ruleId}: id {id}, name {name}, target {targetType}, {allocatedCredits} credits, alarm {alarmThreshold}, groups {accountGroups}.'
slots:
ruleId: path.ruleId
id: requestBody.id
name: requestBody.name
targetType: requestBody.targetType
allocatedCredits: requestBody.allocatedCredits
alarmThreshold: requestBody.alarmThreshold
accountGroups: requestBody.accountGroups
- text: Change allocation rule {ruleId} to {allocatedCredits} credits and alarm {alarmThreshold} (id {id}, {name}, {targetType}, {accountGroups}).
slots:
ruleId: path.ruleId
allocatedCredits: requestBody.allocatedCredits
alarmThreshold: requestBody.alarmThreshold
id: requestBody.id
name: requestBody.name
targetType: requestBody.targetType
accountGroups: requestBody.accountGroups
method: generated
generated: '2026-09-26'
- target: $.paths['/license/api/v1/credit-allocation-rule-names'].get
update:
x-apievangelist-phrasing:
intent: List credit allocation rule names
effect: read
questions:
- What credit allocation rule names exist in my tenant?
- Can I get only the names of my allocation rules?
instructions:
- text: List the names of my credit allocation rules.
- text: Give me every allocation rule name.
method: generated
generated: '2026-09-26'