Focus

IoT Security API Reference

Get Profile Mapping

Table of Contents

Get Profile Mapping

Get a list of mappings of a device profile to a category and vertical.

Synopsis

URI	/pub/v4.0/profile/mapping
HTTP Method	GET
FQDN	<customer-name>.iot.paloaltonetworks.com

Description

Get a list of device profiles with each profile mapped to a category and vertical.

This is not a list of mappings for just the device profiles in your environment but for all device profiles that can appear in IoT Security.

Request Fields

The URL of this request contains the following parameter:

Field	Description
customerid	(`Required`) The customer ID specifies the API call for a specific tenant. The following value is a string.

Request to Get a List of Profile Mappings Example

curl 'https://acmecorp.iot.paloaltonetworks.com/pub/v4.0/profile/mapping?customerid=acmecorp' \
-H 'X-Key-Id: KEY_ID' \
-H 'X-Access-Key: ACCESS_KEY'

Success Response

Upon success, the HTTP response code is 200.

Success Response Example

{
    "mapping": [
        {
            "profile": "Formlabs 3D Printer",
            "category": "3D Printer",
            "vertical": "Office"
        },
        {
            "profile": "Edgewater Networks Device",
            "category": "Network Equipment",
            "vertical": "Network Devices"
        },
        {
            "profile": "Naim Speaker",
            "category": "Smart Speaker",
            "vertical": "Consumer IoT"
        }
        …
    ],
    "count": 3041
}

Error Response

Upon error, the reply includes an HTTP response code, an error message, and additional information describing the error. The HTTP response code is one of the following:

Field	Description
400	Bad Request. This occurs when an HTTP request contains an invalid query string.
403	Forbidden access. Either the provided API Key is invalid or it does not have the required RBAC permissions to run this API.
429	Too many requests. The number of requests for a list of profile mappings exceeded the rate limit of 180 queries per minute per tenant.
500	Internal server error. A unified status for API communication type errors.

Error Response Format

{code: STATUS_CODE, msg: GENERAL_MESSAGE}

Get the Device Inventory

Get Security Alerts