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.
# 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 Labels API
version: 1.0.0
extends: openapi/palo-alto-networks-labels-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: 6
- target: $.paths['/v1/labels'].get
update:
x-apievangelist-phrasing:
intent: List labels with a DIG API key
effect: read
questions:
- How do I list labels using the DIG API key header on the v1 endpoint?
- Which labels does the v1 labels endpoint return for my DIG account?
instructions:
- text: List v1 labels using DIG API key {dig_api_key}.
slots:
dig_api_key: header.dig-api-key
- text: Fetch all labels from the v1 endpoint with key {dig_api_key}.
slots:
dig_api_key: header.dig-api-key
method: generated
generated: '2026-09-26'
- target: $.paths['/labels'].get
update:
x-apievangelist-phrasing:
intent: List labels
effect: read
questions:
- What labels are defined in my configuration?
- Can I search the label list by name and page through it?
instructions:
- text: List my configuration labels.
- text: Find the label named {name}.
slots:
name: query.name
method: generated
generated: '2026-09-26'
- target: $.paths['/labels'].post
update:
x-apievangelist-phrasing:
intent: Create a label
effect: write
questions:
- How do I create a new label with a description?
- Do I need to supply an ID when creating a label?
instructions:
- text: Create label {name} with ID {id}.
slots:
name: requestBody.name
id: requestBody.id
- text: Add a label {name} (ID {id}) described as {description}.
slots:
name: requestBody.name
id: requestBody.id
description: requestBody.description
method: generated
generated: '2026-09-26'
- target: $.paths['/labels/{id}'].get
update:
x-apievangelist-phrasing:
intent: Get a label
effect: read
questions:
- What are the details of a specific label?
- Can I look a label up by its ID?
instructions:
- text: Show label {id}.
slots:
id: path.id
- text: Get the name and description of label {id}.
slots:
id: path.id
method: generated
generated: '2026-09-26'
- target: $.paths['/labels/{id}'].put
update:
x-apievangelist-phrasing:
intent: Update a label
effect: write
questions:
- How do I rename an existing label?
- Can I change a label's description after creating it?
instructions:
- text: Rename label {id} to {name}.
slots:
id: path.id
name: requestBody.name
- text: Set the description of label {id} named {name} to {description}.
slots:
id: path.id
name: requestBody.name
description: requestBody.description
method: generated
generated: '2026-09-26'
- target: $.paths['/labels/{id}'].delete
update:
x-apievangelist-phrasing:
intent: Delete a label
effect: destructive
questions:
- How do I delete a label I no longer need?
- Is removing a label by ID reversible?
instructions:
- text: Delete label {id}.
slots:
id: path.id
- text: Remove the unused label {id}.
slots:
id: path.id
method: generated
generated: '2026-09-26'
Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we
store it to create your key and to recognise you if you sign in with another
provider. See our Privacy Policy and
Terms.