Palo Alto Networks IoT Public API
The IoT Public APIs are listed below.
Operations 56
Each operation below carries the questions people ask an LLM about it and the instructions they give an agent to run it. Generated by API Evangelist overlay
Ask an LLM
“What does IoT Security know about the device with a given MAC address?”
“Can I look up a static-IP device's details the same way I look up a MAC address?”
Tell an agent
Show me the IoT device details for this MAC address.
Pull the device record for the static IP device I'm asking about by its MAC-or-IP lookup.
Ask an LLM
“Which device is sitting at a particular IP address in my IoT inventory?”
“Can I get IoT device details if I only know the IP address, not the MAC?”
Tell an agent
Get the IoT device details for this IP address.
Identify the device behind this IP using the per-IP device lookup.
Ask an LLM
“How do I export every device in my IoT Security inventory?”
“What's the rate limit when pulling the whole device inventory list?”
Tell an agent
List all devices in my IoT Security inventory using the original v1 inventory.
Dump the complete IoT device inventory.
GET
/iot/pub/v2/device/list
List the device inventory with chosen attributes · Get the Device Inventory V2
#
Ask an LLM
“Can I choose which device attributes come back when I pull the IoT inventory?”
“Is there a newer inventory endpoint for Strata Cloud Manager customers?”
Tell an agent
List my IoT devices with the v2 inventory, returning only the attributes I pick.
Pull the SCM device inventory v2 with a trimmed attribute set.
GET
/iot/pub/v2/device/search
Search for a device or multi-interface device · Search Device or Multi-interface Device
#
Ask an LLM
“How can I find a multi-interface device by one of its IP or MAC addresses?”
“Is there a device search that works for SCM customers but not the standalone portal?”
Tell an agent
Search for the device or multi-interface device matching this IP or MAC.
Run a v2 device search to find every interface of this device.
GET
/iot/pub/v1/profile/mapping
Map device profiles to categories and verticals · Get Profile Mapping
#
Ask an LLM
“Which category and industry vertical does each IoT device profile belong to?”
“Can I get the mapping for all possible device profiles, not just the ones on my network?”
Tell an agent
Get the full device profile to category and vertical mapping.
Show which industry vertical each IoT device profile maps to.
Ask an LLM
“What user-defined tags have been assigned to my IoT devices?”
“Where can I see all the manual tags people created for devices?”
Tell an agent
List the user-defined tags on my IoT devices.
Show me every manual device tag in use.
Ask an LLM
“How do I tag a group of IoT devices manually?”
“Can I apply one manual tag to several devices at once?”
Tell an agent
Add a manual tag to these IoT devices.
Tag the devices I listed with a new manual tag.
Ask an LLM
“How do I take a manual tag off some IoT devices?”
“Can I strip a user-defined tag from several devices in one call?”
Tell an agent destructive · confirm first
Remove the manual tag from these devices.
Untag the listed IoT devices.
Ask an LLM
“What security alerts has IoT Security raised on my devices?”
“How often can I poll the security alert list?”
Tell an agent
List my IoT security alerts.
Pull the current security alerts from IoT Security.
Ask an LLM
“How do I mark an IoT security alert as resolved?”
“Can I close out a security alert through the API?”
Tell an agent
Resolve this IoT security alert.
Mark the alert I just reviewed as resolved.
Ask an LLM
“Which vulnerabilities have been found on my IoT devices?”
“Can I pull every vulnerability instance IoT Security is tracking?”
Tell an agent
List the vulnerability instances on my IoT devices.
Show open device vulnerabilities from IoT Security.
PUT
/iot/pub/v1/vulnerability/update
Resolve vulnerability instances · Resolve Vulnerabilty Instances
#
Ask an LLM
“How do I mark a device vulnerability as fixed?”
“Can I resolve several instances of a vulnerability at once?”
Tell an agent
Mark these vulnerability instances as resolved.
Resolve the vulnerability on the devices we patched.
PUT
/iot/pub/v1/device/bulkUpdate
Bulk update devices from Cisco DNAC or Prime · Bulk Device Updates - Cisco DNAC and Prime
#
Ask an LLM
“Can I enrich IoT devices with data from Cisco DNA Center?”
“How do I push Cisco Prime device info into IoT Security in bulk?”
Tell an agent
Bulk update my IoT devices with the Cisco DNA Center data from XSOAR.
Push Cisco Prime device information into the IoT inventory.
PUT
/iot/pub/v1/device/bulkUpdate?updateSource=cisco_wlc
Bulk update devices from Cisco WLAN controllers · Bulk Device Updates - Cisco WLC
#
Ask an LLM
“Can device details from Cisco wireless LAN controllers update my IoT inventory?”
“What's the bulk update source for Cisco WLC data?”
Tell an agent
Bulk update devices with data pulled from our Cisco WLAN controllers.
Sync Cisco WLC client info into IoT Security.
PUT
/iot/pub/v1/device/bulkUpdate?updateSource=aruba_wlc
Bulk update devices from Aruba WLAN controllers · Bulk Device Updates - Aruba WLC
#
Ask an LLM
“Can I feed Aruba wireless controller data into IoT Security?”
“Which bulk update handles devices seen by Aruba WLCs?”
Tell an agent
Bulk update IoT devices with information from our Aruba WLAN controllers.
Sync Aruba WLC device data into the inventory.
PUT
/iot/pub/v1/device/bulkUpdate?updateSource=snmp
Bulk update devices from SNMP switch data · Bulk Device Updates - SNMP
#
Ask an LLM
“Can switch data collected over SNMP update my IoT devices?”
“Which bulk update source uses SNMP from integrated switches?”
Tell an agent
Bulk update devices with the switch data XSOAR gathered over SNMP.
Push SNMP-sourced switch port info into IoT Security.
PUT
/iot/pub/v1/device/bulkUpdate?updateSource=cellular
Bulk update cellular devices · Bulk Device Updates - Cellular Devices
#
Ask an LLM
“Is there a bulk update just for cellular IoT devices?”
“Can I refresh cellular device records in one request?”
Tell an agent
Run a bulk update for our cellular devices.
Update the cellular device records in IoT Security in bulk.
PUT
/iot/pub/v1/device/bulkUpdate?updateSource=sccm
Bulk update devices from SCCM · Bulk Device Updates - SCCM Devices
#
Ask an LLM
“Can I sync SCCM-managed devices into IoT Security?”
“Which bulk update source covers SCCM device data?”
Tell an agent
Bulk update IoT devices with our SCCM device data.
Push SCCM endpoint info into the device inventory.
PUT
/iot/pub/v1/device/bulkUpdate?updateSource=crowdstrike_falcon
Bulk update devices from CrowdStrike Falcon · Bulk Device Updates - Crowdstrike Falcon Devices
#
Ask an LLM
“Can CrowdStrike Falcon device data enrich my IoT inventory?”
“Which bulk update source is for Falcon-managed devices?”
Tell an agent
Bulk update devices with data from CrowdStrike Falcon.
Sync Falcon device details into IoT Security.
PUT
/iot/pub/v1/network/subnetBulkUpdate?updateSource=ipam_infoblox
Bulk update subnets from Infoblox IPAM · Bulk Subnet Updates - IPAM Infoblox
#
Ask an LLM
“Can I import subnets from our Infoblox IPAM into IoT Security?”
“Is there a bulk subnet update for IPAM data?”
Tell an agent
Bulk update IoT Security subnets from our Infoblox IPAM.
Sync IPAM subnet definitions into IoT Security.
PUT
/iot/pub/v1/device/bulkUpdate?updateSource=customAttribute
Bulk set custom attribute values on devices · Bulk Device Updates - Custom Attribute
#
Ask an LLM
“How do I set custom attribute values on many devices at once?”
“Can I bulk-fill a custom attribute across my device inventory?”
Tell an agent
Bulk update custom attribute values on these devices.
Set our custom attribute value across the listed devices.
GET
/iot/pub/v1/policy/recommendation
Get activated policy rule recommendations · Get Activated Policy Rule Recommendations
#
Ask an LLM
“Which firewall policy rule recommendations are activated for my IoT devices?”
“Can I get recommendations for just one or two device profiles?”
Tell an agent
Fetch all activated policy rule recommendations.
Get the activated recommendations for the device profiles I care about.
GET
/iot/pub/v1/alertVuln/capability
List alert and vulnerability capabilities · Get Alert or Vulnerability Capabilities
#
Ask an LLM
“What alert and vulnerability capabilities does my IoT Security tenant have right now?”
“Which IoT capabilities apply to alerts versus vulnerabilities?”
Tell an agent
List the current IoT alert and vulnerability capabilities.
Show which alert and vulnerability features are enabled.
PUT
/iot/pub/v1/network/ndNodeGraphBulkUpdate
Bulk update network discovery node graphs · Network Discovery Bulk Device Node Graph Updates
#
Ask an LLM
“How do network discovery results update the device node graph?”
“Can I push node graph data for discovered devices in bulk?”
Tell an agent
Bulk update the node graph for our network discovery devices.
Push the discovered device node graph into IoT Security.
PUT
/iot/pub/v1/network/ndNodeL2L3BulkUpdate
Bulk update network discovery L2/L3 data · Network Discovery Bulk Device L2L3 Updates
#
Ask an LLM
“Can I upload layer 2 and layer 3 data for discovered devices?”
“Which bulk update carries L2L3 info from network discovery?”
Tell an agent
Bulk update L2/L3 details for network discovery devices.
Push discovered layer 2 and layer 3 device data.
PUT
/iot/pub/v1/network/ndNodeEndpointBulkUpdate
Bulk update network discovery endpoints · Network Discovery Bulk Device Endpoint Updates
#
Ask an LLM
“How do I send endpoint data for devices found by network discovery?”
“Can discovered endpoints be updated in bulk?”
Tell an agent
Bulk update endpoint data for network discovery devices.
Push discovered endpoints into IoT Security.
GET
/iot/pub/v1/xsoar/integrations
List active XSOAR integrations · Get a list of active integrations
#
Ask an LLM
“Which XSOAR integrations are active and succeeding for IoT Security?”
“Is there a cap on integrations with a basic third-party license?”
Tell an agent
List my active XSOAR integrations.
Show which third-party integrations are currently running successfully.
POST
/iot/pub/v1/xsoar/device/reportUpload
Upload a device vulnerability scan report · Collect Device Vulnerability Scan report from Xsoar Server
#
Ask an LLM
“How does XSOAR send a device vulnerability scan report back to IoT Security?”
“Can scan reports from XSOAR be uploaded to IoT?”
Tell an agent
Upload this device vulnerability scan report from XSOAR.
Report the XSOAR scan results back to IoT Security.
POST
/iot/pub/v1/xsoar/profile/aclSync/status
Report profile ACL sync job status · Collect Profile ACL Sync Job Status
#
Ask an LLM
“How does IoT Security learn whether a profile ACL sync job finished?”
“Can XSOAR report ACL sync status back to IoT?”
Tell an agent
Send the profile ACL sync job status from XSOAR.
Report that the ACL sync for these profiles completed.
POST
/iot/pub/v1/xsoar/device/scanDetails
Report third-party scanner details · Collect 3rd party scanner details from Xsoar Server
#
Ask an LLM
“Can XSOAR pass along details about third-party scanners to IoT Security?”
“Where do I submit 3rd party scanner info collected by XSOAR?”
Tell an agent
Submit the third-party scanner details XSOAR collected.
Send our external scanner details to IoT Security.
PUT
/iot/pub/v1/network/securityRules
Update firewall security rules · update a list of firewall security rules
#
Ask an LLM
“Can I update a list of firewall security rules from IoT Security?”
“How do I push changed firewall rules through the IoT API?”
Tell an agent
Update these firewall security rules.
Push the revised security rule list to the firewall.
DELETE
/iot/pub/v1/network/purgeRules
Purge firewall rules not in a kept list · retain the incoming list of rules while remove everything else
#
Ask an LLM
“How do I remove invalid firewall rules while keeping the ones I list?”
“Can I purge every rule except a retained set?”
Tell an agent destructive · confirm first
Keep only the rules I'm sending and purge every other firewall rule.
Remove invalid firewall security rules outside this retained list.
PUT
/iot/pub/v1/thirdPartyScan
Merge third-party CVE findings into devices · update device CVE from 3rd party integration and join with enxisting IoT device…
#
Ask an LLM
“Can CVEs from a third-party scanner be joined with IoT device CVE records?”
“How do I update device CVEs from an external integration?”
Tell an agent
Update device CVEs with these third-party scan results.
Merge the external scanner's CVE findings into our IoT device records.
POST
/iot/pub/v1/xsoar/status
Sync XSOAR playbook status to IoT · sync xsoar integration playbook status to IoT
#
Ask an LLM
“How does IoT Security get the status of an XSOAR integration playbook?”
“Can I sync playbook run status back into IoT?”
Tell an agent
Sync the XSOAR integration playbook status to IoT Security.
Report our playbook run status to IoT.
GET
/iot/pub/v1/xsoar/heartbeat
Send an XSOAR instance heartbeat · IoT uses a heartbeat to track xsoar instance health
#
Ask an LLM
“How does IoT Security know my XSOAR instance is healthy?”
“What heartbeat should an XSOAR instance send to IoT?”
Tell an agent
Send a heartbeat from our XSOAR instance to IoT Security.
Ping IoT with the XSOAR health heartbeat.
Ask an LLM
“What saved filters exist in my IoT Security tenant?”
“Can I retrieve the filters our team saved?”
Tell an agent
List my saved IoT filters.
Show the saved filters in IoT Security.
Ask an LLM
“Which custom attributes have we defined for IoT devices?”
“Can I see all our custom attribute definitions?”
Tell an agent
List the custom attributes defined in IoT Security.
Show all our custom device attribute definitions.
Ask an LLM
“How do I add a new custom attribute for devices?”
“Can I define my own device attribute in IoT Security?”
Tell an agent
Create a new custom device attribute.
Define a custom attribute we can set on devices.
Ask an LLM
“How do I change an existing custom attribute?”
“Can I edit a custom attribute definition after creating it?”
Tell an agent
Update the definition of this existing custom attribute.
Edit our custom attribute's settings.
Ask an LLM
“How do I remove a custom attribute we no longer use?”
“Can a custom attribute definition be deleted?”
Tell an agent destructive · confirm first
Delete this custom attribute.
Remove the unused custom attribute definition.
Ask an LLM
“How do I add new sites to IoT Security?”
“Can I create more than one site definition in a request?”
Tell an agent
Create these new site definitions.
Add our new locations as IoT sites.
Ask an LLM
“What sites are defined in IoT Security?”
“Can I retrieve my site definitions?”
Tell an agent
Get the site definitions from IoT Security.
List our IoT sites.
Ask an LLM
“How do I change an existing site definition?”
“Can I update several sites at once?”
Tell an agent
Update these existing site definitions.
Edit the sites I listed in IoT Security.
Ask an LLM
“How do I remove sites from IoT Security?”
“Can several site definitions be deleted together?”
Tell an agent destructive · confirm first
Delete these site definitions.
Remove the retired sites from IoT Security.
POST
/iot/pub/v1/networkSegment
Create a network segment definition · Create Network Segment Definition
#
Ask an LLM
“How do I add a new network segment?”
“Can I define a network segment in IoT Security?”
Tell an agent
Create a new network segment definition.
Add a network segment for this part of the network.
Ask an LLM
“What network segments are defined in IoT Security?”
“Can I list my network segment definitions?”
Tell an agent
Get our network segment definitions.
List the network segments configured in IoT Security.
PUT
/iot/pub/v1/networkSegment
Update a network segment definition · Update Network Segment Definition
#
Ask an LLM
“How do I change an existing network segment?”
“Can I edit a network segment definition?”
Tell an agent
Update this network segment definition.
Edit the existing network segment's settings.
DELETE
/iot/pub/v1/networkSegment
Delete a network segment definition · Delete Network Segment Definition
#
Ask an LLM
“How do I remove a network segment?”
“Can a network segment definition be deleted?”
Tell an agent destructive · confirm first
Delete this network segment definition.
Remove the obsolete network segment.
Ask an LLM
“How do I add a new subnet to IoT Security?”
“Can I define a subnet through the API?”
Tell an agent
Create a new subnet definition.
Add this subnet to IoT Security.
Ask an LLM
“What subnets are defined in IoT Security?”
“Can I retrieve my subnet definitions?”
Tell an agent
Get the subnet definitions from IoT Security.
List our defined subnets.
Ask an LLM
“How do I change an existing subnet definition?”
“Can a subnet's settings be edited?”
Tell an agent
Update this subnet definition.
Edit the existing subnet in IoT Security.
Ask an LLM
“How do I remove a subnet definition?”
“Can I delete a subnet from IoT Security?”
Tell an agent destructive · confirm first
Delete this subnet definition.
Remove the unused subnet.
PUT
/iot/pub/v1/subnet/transfer
Transfer a subnet to a shared IP block · Transfer to Shared IP Block
#
Ask an LLM
“How do I move a subnet into a shared IP block?”
“Can a subnet be shared across sites as an IP block?”
Tell an agent
Transfer this subnet to a shared IP block.
Make the subnet part of a shared IP block.
Ask an LLM
“How do I undo sharing an IP block?”
“Can a shared block go back to being an unshared IP block?”
Tell an agent
Revert this shared block to an unshared IP block.
Unshare the IP block I transferred earlier.
Ask an LLM
“Which device attributes, including third-party integration ones, can I query?”
“What attribute names can I request in the v2 inventory?”
Tell an agent
List all device attributes, native and from enabled integrations.
Show the attribute names available for IoT devices.