Palo Alto Networks Device API
The Device API from Palo Alto Networks — 2 operation(s) for device.
Work with this as data
Every API here is available over the APIs.io API and to AI agents over MCP.
MCP server
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
Tools for apis
7 MCP tools reach this
find_apisBrowse and filter every API in the catalog.get_api_artifactsOne API's artifacts, grouped by type.get_openapiThe primary OpenAPI for this API.find_similar_apisAPIs that look like this one.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.
Call it yourself
curl for this page
This API
curl "https://apis.io/api/v1/apis/palo-alto-networks-device-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"Discovery needs no key. Ratings and market analysis are Pro.
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.
A second provider on the same verified email joins the account you already have.
OpenAPI Specification
openapi: 3.2.0
info:
title: Palo Alto Networks Device API
license:
name: Proprietary
url: https://www.paloaltonetworks.com/legal
version: '1.0'
description: 'Operations tagged Device across 3 of this provider''s published API definitions: palo-alto-iot-security-api-openapi-original.yml, palo-alto-networks-device-api-openapi.yml, palo-alto-pan-os-rest-api-openapi-original.yml. Each path carries the servers of the definition it was published in.'
servers:
- url: https://{customer}.iot.paloaltonetworks.com/pub/v4.0
description: IoT Security API production server.
variables:
customer:
description: Customer-specific tenant identifier.
default: customer-tenant
- url: https://api.stratacloud.paloaltonetworks.com/aiops/bpa/v1
description: AIOps for NGFW BPA API production server.
- url: https://{firewall}/restapi/v10.2
description: PAN-OS firewall or Panorama REST API endpoint.
variables:
firewall:
description: Hostname or IP address of the PAN-OS firewall or Panorama appliance.
default: firewall.example.com
tags:
- name: Device
paths:
/device/tag/list:
get:
operationId: listDeviceTags
summary: Palo Alto Networks List Device Tags
description: Returns a list of tags defined in the IoT Security tenant. Tags are used to label and categorize devices for filtering, reporting, and policy assignment purposes.
tags:
- Device
parameters:
- name: customerid
in: query
required: true
description: Customer tenant identifier.
schema:
type: string
example: '776473'
- name: offset
in: query
description: Pagination offset for results.
schema:
type: integer
default: 0
example: 0
- name: pagelength
in: query
description: Number of tags to return per page.
schema:
type: integer
default: 100
example: 100
responses:
'200':
description: Device tags returned successfully.
content:
application/json:
schema:
type: object
properties:
total:
type: integer
description: Total number of tags.
tags:
type: array
items:
$ref: '#/components/schemas/DeviceTag'
examples:
ListDeviceTags200Example:
summary: Default listDeviceTags 200 response
x-microcks-default: true
value:
total: 832
tags:
- id: example-id
name: Primary Gateway 96
description: Suspicious traffic violation on network malware.
device_count: 933
created_at: '2024-05-09T23:09:39Z'
'400':
$ref: '#/components/responses/BadRequest'
'401':
$ref: '#/components/responses/Unauthorized'
'500':
$ref: '#/components/responses/InternalServerError'
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
security:
- keyId: []
accessKey: []
servers:
- url: https://{customer}.iot.paloaltonetworks.com/pub/v4.0
description: IoT Security API production server.
variables:
customer:
description: Customer-specific tenant identifier.
default: customer-tenant
/Device/VirtualSystems:
get:
operationId: listVirtualSystems
summary: Palo Alto Networks List Virtual Systems
description: Returns all virtual systems (vsys) configured on the firewall. Virtual systems provide multi-tenancy on a single physical or virtual firewall appliance, each with its own security policy, interfaces, and zones.
tags:
- Device
responses:
'200':
description: Virtual systems returned successfully.
content:
application/json:
schema:
type: object
properties:
'@status':
type: string
'@code':
type: string
result:
type: object
properties:
'@total-count':
type: string
'@count':
type: string
entry:
type: array
items:
$ref: '#/components/schemas/VirtualSystem'
examples:
ListVirtualSystems200Example:
summary: Default listVirtualSystems 200 response
x-microcks-default: true
value:
'@status': running
'@code': example-@code
result:
'@total-count': example-@total-count
'@count': example-@count
entry:
- '@name': Corporate Firewall 67
display-name: Corporate Policy 13
import:
network:
interface:
member:
- example-member_item
- example-member_item
'400':
$ref: '#/components/responses/BadRequest_2'
'401':
$ref: '#/components/responses/Unauthorized_2'
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
security:
- oauth2Bearer: []
servers:
- url: https://api.stratacloud.paloaltonetworks.com/aiops/bpa/v1
description: AIOps for NGFW BPA API production server.
components:
responses:
InternalServerError:
description: Internal server error.
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
BadRequest:
description: Invalid request parameters.
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
Unauthorized:
description: Invalid or missing API keys.
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
Unauthorized_2:
description: Missing or invalid API key.
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse_2'
BadRequest_2:
description: Malformed request or invalid parameters.
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse_2'
BadRequest_3:
description: Malformed request or invalid parameters.
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse_3'
Unauthorized_3:
description: Missing or invalid API key.
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse_3'
schemas:
ErrorResponse:
type: object
properties:
error:
type: string
description: Error code or type.
example: example-error
message:
type: string
description: Human-readable error message.
example: Monitoring traffic activity network investigation investigation network policy traffic violation rule rule.
DeviceTag:
type: object
properties:
id:
type: string
description: Unique tag identifier.
example: example-id
name:
type: string
description: Tag name.
example: Primary Gateway 96
description:
type: string
description: Tag description.
example: Suspicious traffic violation on network malware.
device_count:
type: integer
description: Number of devices assigned this tag.
example: 933
created_at:
type: string
format: date-time
description: Timestamp when the tag was created.
example: '2024-05-09T23:09:39Z'
ErrorResponse_2:
type: object
properties:
'@status':
type: string
example: running
'@code':
type: string
example: example-@code
msg:
type: object
properties:
line:
type: string
description: Error message detail.
example: example-line
example:
line: example-line
VirtualSystem:
type: object
description: A virtual system (vsys) on the PAN-OS firewall.
properties:
'@name':
type: string
description: Virtual system name (e.g., vsys1, vsys2).
example: Corporate Firewall 67
display-name:
type: string
description: Human-readable display name for the vsys.
example: Corporate Policy 13
import:
type: object
description: Imported network resources for this vsys.
properties:
network:
type: object
properties:
interface:
type: object
properties:
member:
type: array
items:
type: string
description: Network interfaces assigned to this vsys.
example:
- example-member_item
- example-member_item
example:
member:
- example-member_item
example:
interface:
member:
- example-member_item
example:
network:
interface:
member:
- example-member_item
- example-member_item
ErrorResponse_3:
type: object
properties:
'@status':
type: string
example: running
'@code':
type: string
example: example-@code
msg:
type: object
properties:
line:
type: string
description: Error message detail.
example: example-line
example:
line: example-line
securitySchemes:
keyId:
type: apiKey
in: header
name: X-Key-Id
description: IoT Security API key identifier. Generated from the IoT Security portal under Settings > API Keys.
accessKey:
type: apiKey
in: header
name: X-Access-Key
description: IoT Security API access key. Generated alongside the key identifier from the IoT Security portal.
oauth2Bearer:
type: http
scheme: bearer
bearerFormat: JWT
description: OAuth 2.0 Bearer token for SASE platform authentication. Obtain using the client_credentials grant with your SASE service account client ID and client secret.
apiKey:
type: apiKey
in: header
name: X-PAN-KEY
description: PAN-OS API key generated via the /api/?type=keygen endpoint or from the web interface under Device > Administrators. The key is tied to an administrator account and inherits its role-based permissions.
x-refined-from:
- palo-alto-iot-security-api-openapi-original.yml
- palo-alto-networks-device-api-openapi.yml
- palo-alto-pan-os-rest-api-openapi-original.yml