Palo Alto Networks Devices API
The Devices API from Palo Alto Networks — 10 operation(s) for devices.
The Devices API from Palo Alto Networks — 10 operation(s) for devices.
openapi: 3.2.0
info:
title: Palo Alto Networks Devices API
version: '1.0'
description: 'Operations tagged Devices across 2 of this provider''s published API definitions: palo-alto-access-browser-mgmt-prismaaccess-browser-management-latest-openapi.yaml, palo-alto-scm-config-cloudngfw-setup-config-setup-feb-v1-openapi.yaml. Each path carries the servers of the definition it was published in.'
servers:
- url: https://api.strata.paloaltonetworks.com/config/setup/v1
description: Current
tags:
- name: Devices
paths:
/seb-api/v1/devices:
get:
summary: Returns a list of devices
description: Retrieve the devices details through this Application Programming Interface endpoint.
operationId: GetSeb-apiV1Devices
responses:
'200':
description: A list of devices with pagination info
content:
application/json:
schema:
type: object
properties:
pageInfo:
$ref: '#/components/schemas/PageInfo'
data:
type: array
items:
$ref: '#/components/schemas/Device'
'400':
description: Bad request
'500':
description: Internal server error
parameters:
- name: limit
in: query
description: Number of devices to return
required: false
schema:
type: integer
format: int32
- name: device.hostname
in: query
description: Filter by hostname
required: false
schema:
type: string
- name: user.name
in: query
description: Filter by user name
required: false
schema:
type: string
- name: device.os_type
in: query
description: Filter by OS type
required: false
schema:
type: string
- name: device.first_seen_gte
in: query
description: Filter by first seen time or after
required: false
schema:
type: string
format: date-time
- name: device.last_seen_lte
in: query
description: Filter by last seen time or before
required: false
schema:
type: string
format: date-time
- name: device.last_seen_gte
in: query
description: Filter by last seen time or after
required: false
schema:
type: string
format: date-time
- name: device.type
in: query
description: Filter by device type
required: false
schema:
type: string
- name: device.firewall_status
in: query
description: Filter by firewall status
required: false
schema:
type: string
- name: device.screen_lock_status
in: query
description: Filter by screen lock status
required: false
schema:
type: string
- name: device.disk_encryption_status
in: query
description: Filter by disk encryption status
required: false
schema:
type: string
- name: cursor
in: query
description: An optional opaque string that defines from where to start listing
required: false
schema:
type: string
- name: sort
in: query
description: The field to sort by
required: false
schema:
type: string
enum:
- device.hostname
- device.os_type
- device.browser_version
- device.first_seen
- device.last_seen
- user.name
- name: order
in: query
description: The sort order
required: false
schema:
$ref: '#/components/schemas/Order'
tags:
- Devices
security:
- BearerAuth: []
/seb-api/v1/devices/{id}:
get:
summary: Returns a device by ID
description: Retrieve the {id} details through this Application Programming Interface endpoint.
operationId: GetSeb-apiV1Devicesbyid
responses:
'200':
description: A device
content:
application/json:
schema:
$ref: '#/components/schemas/Device'
'404':
description: Device not found
parameters:
- name: id
in: path
description: Device ID
required: true
schema:
type: string
tags:
- Devices
security:
- BearerAuth: []
/seb-api/v1/devices/archive:
post:
summary: Archive devices
description: Archive one or more devices by changing their status to archived.
operationId: PostSeb-apiV1DevicesArchive
responses:
'200':
description: Devices archived successfully
content:
application/json:
schema:
$ref: '#/components/schemas/DeviceArchiveResponse'
'400':
description: Bad request - invalid input
content:
application/json:
schema:
type: object
properties:
errorResponse:
$ref: '#/components/schemas/ErrorResponse'
'403':
description: Forbidden
'404':
description: One or more devices not found
content:
application/json:
schema:
type: object
properties:
errorResponse:
$ref: '#/components/schemas/ErrorResponse'
'500':
description: Internal server error
parameters: []
tags:
- Devices
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/DeviceStatusChangeRequest'
security:
- BearerAuth: []
/seb-api/v1/devices/restore:
post:
summary: Restore archived devices
description: Restore one or more archived devices by changing their status to active.
operationId: PostSeb-apiV1DevicesRestore
responses:
'200':
description: Devices restored successfully
content:
application/json:
schema:
$ref: '#/components/schemas/DeviceRestoreResponse'
'400':
description: Bad request - invalid input
content:
application/json:
schema:
type: object
properties:
errorResponse:
$ref: '#/components/schemas/ErrorResponse'
'403':
description: Forbidden
'404':
description: One or more devices not found
content:
application/json:
schema:
type: object
properties:
errorResponse:
$ref: '#/components/schemas/ErrorResponse'
'500':
description: Internal server error
parameters: []
tags:
- Devices
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/DeviceStatusChangeRequest'
security:
- BearerAuth: []
/seb-api/v1/devices/suspend:
post:
summary: Suspend devices
description: Suspend one or more devices by changing their status to suspended.
operationId: PostSeb-apiV1DevicesSuspend
responses:
'200':
description: Devices suspended successfully
content:
application/json:
schema:
$ref: '#/components/schemas/DeviceSuspendResponse'
'400':
description: Bad request - invalid input
content:
application/json:
schema:
type: object
properties:
errorResponse:
$ref: '#/components/schemas/ErrorResponse'
'403':
description: Forbidden
'404':
description: One or more devices not found
content:
application/json:
schema:
type: object
properties:
errorResponse:
$ref: '#/components/schemas/ErrorResponse'
'500':
description: Internal server error
parameters: []
tags:
- Devices
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/DeviceStatusChangeRequest'
security:
- BearerAuth: []
/seb-api/v1/devices/resume:
post:
summary: Resume suspended devices
description: Resume one or more suspended devices by changing their status to active.
operationId: PostSeb-apiV1DevicesResume
responses:
'200':
description: Devices resumed successfully
content:
application/json:
schema:
$ref: '#/components/schemas/DeviceResumeResponse'
'400':
description: Bad request - invalid input
content:
application/json:
schema:
type: object
properties:
errorResponse:
$ref: '#/components/schemas/ErrorResponse'
'403':
description: Forbidden
'404':
description: One or more devices not found
content:
application/json:
schema:
type: object
properties:
errorResponse:
$ref: '#/components/schemas/ErrorResponse'
'500':
description: Internal server error
parameters: []
tags:
- Devices
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/DeviceStatusChangeRequest'
security:
- BearerAuth: []
/seb-api/v1/devices/delete:
post:
summary: Delete devices
description: Delete one or more devices permanently. Suspended devices cannot be deleted - they must be resumed first.
operationId: PostSeb-apiV1DevicesDelete
responses:
'200':
description: Devices deleted successfully
content:
application/json:
schema:
$ref: '#/components/schemas/DeviceDeleteResponse'
'400':
description: Bad request - invalid input or attempting to delete suspended devices
content:
application/json:
schema:
type: object
properties:
errorResponse:
$ref: '#/components/schemas/ErrorResponse'
'403':
description: Forbidden
'404':
description: One or more devices not found
content:
application/json:
schema:
type: object
properties:
errorResponse:
$ref: '#/components/schemas/ErrorResponse'
'500':
description: Internal server error
parameters: []
tags:
- Devices
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/DeviceStatusChangeRequest'
security:
- BearerAuth: []
/seb-api/v1/devices/force-reauth:
post:
summary: Force re-authentication for devices
description: Force re-authentication on one or more specific devices. Upon execution, targeted devices will require their user to re-authenticate to the browser.
operationId: PostSeb-apiV1DevicesForce-reauth
responses:
'200':
description: Force re-authentication initiated successfully
content:
application/json:
schema:
$ref: '#/components/schemas/DeviceForceReauthResponse'
'400':
description: Bad request - invalid input or too many devices
content:
application/json:
schema:
type: object
properties:
errorResponse:
$ref: '#/components/schemas/ErrorResponse'
'403':
description: Forbidden
'404':
description: One or more devices not found
content:
application/json:
schema:
type: object
properties:
errorResponse:
$ref: '#/components/schemas/ErrorResponse'
'500':
description: Internal server error
parameters: []
tags:
- Devices
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/DeviceStatusChangeRequest'
security:
- BearerAuth: []
/devices:
get:
summary: List devices
description: 'Retrieve a list of devices.
'
tags:
- Devices
operationId: ListDevices
parameters:
- $ref: '#/components/parameters/pagination-optional'
- $ref: '#/components/parameters/limit-optional'
- $ref: '#/components/parameters/offset-optional'
- $ref: '#/components/parameters/name-optional'
responses:
'200':
content:
application/json:
schema:
type: object
properties:
data:
allOf:
- type: array
items:
$ref: '#/components/schemas/devices'
limit:
type: integer
default: 200
offset:
type: integer
default: 0
total:
type: integer
description: OK
'400':
$ref: '#/components/responses/bad_request_errors_basic'
'401':
$ref: '#/components/responses/auth_errors'
'403':
$ref: '#/components/responses/access_errors'
'404':
$ref: '#/components/responses/not_found'
default:
$ref: '#/components/responses/default_errors'
security:
- scmToken: []
servers:
- url: https://api.strata.paloaltonetworks.com/config/setup/v1
description: Current
/devices/{id}:
get:
summary: Get a device
description: 'Retrieve an existing device.
'
tags:
- Devices
operationId: GetDeviceByID
parameters:
- $ref: '#/components/parameters/uuid'
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/devices'
description: OK
'400':
$ref: '#/components/responses/bad_request_errors_basic'
'401':
$ref: '#/components/responses/auth_errors'
'403':
$ref: '#/components/responses/access_errors'
'404':
$ref: '#/components/responses/not_found'
default:
$ref: '#/components/responses/default_errors'
security:
- scmToken: []
put:
summary: Update a device
description: 'Update an existing device.
'
tags:
- Devices
operationId: UpdateDeviceByID
parameters:
- $ref: '#/components/parameters/uuid'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/devices-put'
description: The `device` resource definition.
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/devices'
'400':
$ref: '#/components/responses/bad_request_errors_basic_with_body'
'401':
$ref: '#/components/responses/auth_errors'
'403':
$ref: '#/components/responses/access_errors'
'404':
$ref: '#/components/responses/not_found'
'409':
$ref: '#/components/responses/conflict_errors'
default:
$ref: '#/components/responses/default_errors'
security:
- scmToken: []
servers:
- url: https://api.strata.paloaltonetworks.com/config/setup/v1
description: Current
components:
schemas:
DevicePlatform:
type: string
description: Device platform
enum:
- Desktop Browser
- Mobile Browser
- Browser Extension
- Unknown
DeviceStatusChangeRequest:
type: object
properties:
deviceIds:
type: array
items:
type: string
description: List of device IDs
minItems: 1
required:
- deviceIds
DeviceForceReauthResponse:
type: object
properties:
forcedReauthDeviceIds:
type: array
items:
type: string
description: List of device IDs that were force re-authenticated
message:
type: string
example: Force re-authentication initiated for 2 devices
DiskEncryptionProduct:
type: object
description: Disk encryption product information
required:
- vendorName
- productName
- fullyEncrypted
properties:
vendorName:
$ref: '#/components/schemas/DiskEncryptionVendorName'
productName:
type: string
description: Product name of the disk encryption product
BrowserSelfProtectionModule:
type: object
description: Browser self-protection module
properties:
windows:
type: object
description: Windows driver info
properties:
status:
$ref: '#/components/schemas/BrowserSelfProtectionWindowsDriverStatus'
CrowdstrikeZTAPosture:
type: object
required:
- score
- sensorScore
- osScore
- CID
properties:
score:
type: integer
sensorScore:
type: integer
osScore:
type: integer
CID:
type: string
DeviceDeleteResponse:
type: object
properties:
deletedDeviceIds:
type: array
items:
type: string
description: List of device IDs that were deleted
message:
type: string
example: 3 devices deleted successfully
FirewallVendorName:
type: string
description: Firewall vendor name
enum:
- Agnitum Ltd.
- NETGATE Technologies s.r.o.
- ParetoLogic, Inc.
- LANDESK Software, Inc.
- AT&T
- Bitdefender
- Mysecuritywin
- G Data Software AG
- Max Secure Software
- AhnLab, Inc.
- AVG Technologies CZ, s.r.o.
- Symantec Corporation
- Kaspersky Lab
- Avira GmbH
- Panda Security, S.L.
- Webroot Software, Inc.
- Quick Heal Technologies (P) Ltd.
- nProtect, Inc.
- F-Secure Corporation
- ThreatTrack Security, Inc.
- McAfee, Inc.
- eEye Digital Security
- Arcabit
- BeyondTrust, Inc.
- Telefónica S.A.
- GEN-X Technologies
- K7 Computing Pvt Ltd
- Faronics Corporation
- TELUS
- Kingsoft Corporation
- BiniSoft.org
- GFI Software Ltd.
- TG Soft S.a.s.
- Scandium Security Inc.
- Datpol
- Tech Guard Technologies
- NCP engineering GmbH
- SoftSphere Technologies
- Quick Guard Technologies
- Emsisoft Ltd
- Datalink Industrial Corporation
- COMODO Security Solutions
- MicroWorld Technologies Inc.
- AVAST Software a.s.
- ESET
- Beijing Rising Information Technology Co., Ltd.
- Smart Heal
- Rogers
- Check Point Software Technologies
- CellSecurity
- AS3 Soft4U
- Ates Software & Internet Technologies
- MSecure Data Labs
- SGA SOLUTIONS
- ALLIT Service, LLC.
- adaware
- SentinelOne
- CrowdStrike, Inc.
- CSIS Security Group
- SOURCENEXT CORPORATION
- Microsoft Corporation
- SecureMix LLC
- Swiss security laboratory.
- AsiaInfo, Inc.
- INCA Internet Co., Ltd.
- ESTsoft Corp.
- Sunrise Antivirus
- Hauri, Inc.
- SecuraShield India Pvt. Ltd.
- NIFTY Corporation
- Trend Micro, Inc.
- Fujitsu Services Ltd.
- LogMeIn, Inc.
- Stormshield
- Palo Alto Networks, Inc.
- Chili Security
- Sophos Limited
- NortonLifeLock Inc
- Massachusetts Institute of Technology
- WatchGuard Technologies Inc
- Beijing Huorong Network Technology Co., Ltd.
- Le Minh Thanh
- Qi An Xin Group
- Avast Software s.r.o.
- TEHTRIS
- Avira Operations GmbH & Co. KG
- WithSecure Corporation
- Musarubra US LLC.
- GoTo, Inc.
- INCA Internet Co.,Ltd.
- SECURA WEB DATA LABS PVT LTD
- Broadcom
- Gen Digital Inc.
- Actipace Private Limited
- Siyano Labs Pvt. Ltd.
- Bkav Corporation
- CMC InfoSec
- Total Defense, Inc.
- TrustPort, a.s.
- Fortinet Inc.
- Avanquest Software
- Doctor Web, Ltd.
- Security Software Limited
- BullGuard Ltd.
- HDD Labs. Inc
- EarthLink, Inc.
- Roboscan Inc
- Thirtyseven4
- PC Security Shield
- CA, Inc.
- Privacyware/PWI, Inc.
- Károly Pados
- PeerBlock, LLC
- ProgrammerWorld.Net
- Jetico, Inc.
- Tiny Software Inc.
- Sphinx Software
- Defender Pro
- Soft4Ever
- Lavasoft
- Norman AS
- PC Tools Software
- Apple Inc.
LocationMethod:
type: string
description: Location detection method
enum:
- GeoIp
- Location services
- Unknown
DeviceEPP:
type: object
required:
- products
- enabled
properties:
products:
type: array
items:
$ref: '#/components/schemas/EPP'
enabled:
type: boolean
Device:
type: object
properties:
id:
type: string
format: string
description: Unique identifier
externalId:
type: string
format: string
description: External identifier
status:
type: string
description: Device status
enum:
- active
- archived
- suspended
firstSeen:
type: string
format: date-time
description: First seen time
lastSeen:
type: string
format: date-time
description: Last seen time
osType:
type: string
description: Operating System type
enum:
- windows
- macOS
- linux
- ios
- android
- unknown
osVersion:
type: string
description: OS Version
osDisplayName:
type: string
description: OS Display Name
chromeosVersion:
type: string
description: ChromeOS version (only for ChromeOS devices)
locationMethod:
$ref: '#/components/schemas/LocationMethod'
arch:
type: string
description: Architecture
nativeArch:
type: string
description: Native Architecture
hostname:
type: string
description: Hostname
model:
type: string
description: Device Model
serialNumber:
type: string
description: Serial Number
mobileVendor:
type: string
description: Mobile device vendor/manufacturer (e.g., Samsung, Apple)
mobileHardware:
type: string
description: Mobile device hardware identifier (e.g., iPhone14,2, SM-G998B)
mobileIsRooted:
type: boolean
description: Whether the mobile device is rooted/jailbroken
macAddresses:
type: array
items:
type: string
description: MAC Addresses
screenLockStatus:
type: string
description: Screen Lock Status
enum:
- ScreenLockStatusUnknown
- ScreenLockStatusDisabled
- ScreenLockStatusEnabled
diskEncryptionStatus:
type: string
description: Disk Encryption Status
enum:
- DiskEncryptionStatusUnknown
- DiskEncryptionStatusDisabled
- DiskEncryptionStatusEnabled
diskEncryptionDetails:
$ref: '#/components/schemas/DeviceDiskEncryptionDetails'
firewallStatus:
type: string
description: Firewall Status
enum:
- FireWallStatusUnknown
- FireWallStatusDisabled
- FireWallStatusEnabled
firewallDetails:
$ref: '#/components/schemas/DeviceFirewallDetails'
userAgent:
type: string
description: User Agent
ip:
type:
- string
- 'null'
description: IP Address
talonExtensionVersion:
type: string
description: Talon Extension Version
browserVersion:
type: string
description: Browser Version
browserBrand:
$ref: '#/components/schemas/DeviceBrowserBrand'
deviceType:
type: string
description: Device Type
enum:
- unknown
- desktop
- laptop
- vm
- smartphone
- tablet
- chromebook
platform:
$ref: '#/components/schemas/DevicePlatform'
deviceEPP:
$ref: '#/components/schemas/DeviceEPP'
devicePassword:
$ref: '#/components/schemas/DevicePasswordPosture'
crowdstrikeZTA:
$ref: '#/components/schemas/CrowdstrikeZTAPosture'
systemIntegrity:
$ref: '#/components/schemas/SystemIntegrityPosture'
isRunningOnRemoteSession:
type: boolean
description: Whether the device is running on a remote session (e.g., RDP, VNC)
deviceManagement:
$ref: '#/components/schemas/DeviceManagement'
browserSelfProtectionModule:
$ref: '#/components/schemas/BrowserSelfProtectionModule'
isOSUserAdmin:
type: boolean
description: OS user is admin
isBrowserInstalledAsAdmin:
type: boolean
description: Browser installed as admin
user:
$ref: '#/components/schemas/User'
required:
- id
- status
- firstSeen
- lastSeen
- osType
- osDisplayName
- platform
- browserBrand
- arch
- nativeArch
- hostname
- model
- serialNumber
- macAddresses
- screenLockStatus
- diskEncryptionStatus
- firewallStatus
- isBrowserInstalledAsAdmin
- userAgent
- talonExtensionVersion
- browserVersion
- deviceType
- osVersion
- externalId
DeviceManagementSystem:
type: object
properties:
system:
type: string
enum:
- ad
- azureAd
- intune
- jamf
details:
type: string
PageInfo:
type: object
properties:
hasNextPage:
type: boolean
description: When paginating forwards, are there more items?
cursor:
type:
- string
- 'null'
description: When paginating forwards, the cursor to continue.
required:
- hasNextPage
BrowserSelfProtectionWindowsDriverStatus:
type: string
description: Windows driver status
default: Unknown
enum:
- Unknown
- Protected
- Inactive
- UnprotectedArmIncompatible
- UnprotectedUserInstall
- Unprotected
User:
type: object
properties:
id:
type: string
format: string
description: Unique identifier
externalId:
type: string
format: string
description: External identifier
email:
type: string
description: Email
lastSeen:
type: string
format: date-time
description: Last seen time
firstSeen:
type: string
format: date-time
description: First seen time
name:
type: string
description: Name
profilePictureURL:
type: string
description: Profile Picture URL
deletedTime:
type: string
format: date-time
description: Deleted Time
status:
$ref: '#/components/schemas/UserStatus'
provider:
type: string
description: Provider
enum:
- saml
- local
- oidc
deviceIds:
type: array
description: Device IDs
items:
type: string
userGroups:
type: array
description: User Groups
items:
$ref: '#/components/schemas/UserGroup'
required:
- id
- email
- lastSeen
- firstSeen
- name
- profilePictureURL
- deletedTime
- status
- provider
- externalId
DeviceDiskEncryptionDetails:
type: object
description: Disk encryption details for the device
required:
- products
properties:
products:
type: array
description: List of disk encryption products detected on the device
items:
$ref: '#/components/schemas/DiskEncryptionProduct'
Order:
type: string
description: The sort order
enum:
- asc
- desc
DeviceResumeResponse:
type: object
properties:
resumedDeviceIds:
type: array
items:
type: string
description: List of device IDs that were resumed
message:
type: string
example: 3 devices resumed successfully
UserGroup:
type: object
properties:
id:
type: string
description: Unique identifier
name:
type: string
description: Name
lastUpdated:
type: string
format: date-time
description: Last updated
createdAt:
type: string
format: date-time
description: Created at
provider:
type: string
enum:
- sso
- local
description: Provider
required:
- id
- name
DiskEncryptionVendorName:
type: string
description: Disk encryption vendor name
enum:
- 2BrightSparks Pte Ltd
- Acronis
- Adolix
- Apimac, software
- Apple Inc.
- archicrypt
- Arcserve (USA), LLC
- Ashampoo GmbH & Co. KG
- AVG Technologies CZ, s.r.o.
- Axantum Software AB
- AxCrypt AB
- Beachhead Solutions
- Becrypt Ltd
- BeLight Software Ltd.
- Bitdefender
- Braincell consult & research GmbH
- Check Point Software Technologies
- CipherShed
- COMODO Security Solutions
- CoSoSys Ltd.
- CP-Lab.com
- Crypto Systems, Inc.
- Cypherix Software Pvt. Ltd.
- DATEV eG
- Dekart
- Dell Inc.
- Deltacrypt Technologies Inc
- DESlock Limited
- Digital Millenium Inc.
- DoGoodSoft
- EgoSecure
- EGSoftWeb
- ENC Security Systems
- Encrypt4all Software
- ESET
- Evgeny Korovin
- EXLADE, Inc.
- Exosphere Labs, Inc.
- FileEncryption.org.
- G Data Software AG
- GiliSoft International LLC
- GitHub, Inc.
- GitLab Inc.
- Hewlett-Packard
- Hitek Software LLC
- HummerStudio
- IDRIX
- InterCrypto Ltd
- Inv Softworks LLC
- Jetico, Inc.
- Kaspersky Lab
- Kovell Ventures Ltd.
- Kromtech
- Kruptos 2 Software
- Lavasoft
- MadowSoft Software
# --- truncated at 32 KB (54 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/palo-alto-networks/refs/heads/main/openapi/palo-alto-networks-devices-api-openapi.yml