Get Profile Mapping

GET 
/pub/v4.0/profile/mapping

Get a list of mappings of each device profile to a category and industry vertical. This list is for all device profiles that can appear in IoT Security, not just those in your environment.
Rate limiting: 180 times per minute

Request

Query Parameters

customerid stringrequired

The customer ID to which the API call is directed

Responses

200

Successful Response (We only show some important fields here.)

application/json

Schema

Schema

count integerrequired

The total number of profile mappings

mapping object[]required
An array containing profile mappings
Array [
profile string
The name of a device profile
category string
The category to which the profile is mapped
vertical string
The industry vertical to which the profile is mapped
]

Example (from schema)

{
  "count": 0,
  "mapping": [
    {
      "profile": "string",
      "category": "string",
      "vertical": "string"
    }
  ]
}

DeviceDetailPerIPResponseExample

{
  "count": 6,
  "mapping": [
    {
      "profile": "American Dynamics IP Camera",
      "category": "Camera",
      "vertical": "Office"
    },
    {
      "profile": "Hitachi Maxell Device",
      "category": "Electronics IoT",
      "vertical": "Generic IoT"
    },
    {
      "profile": "Mitsumi Electric Device",
      "category": "Electronics IoT",
      "vertical": "Generic IoT"
    },
    {
      "profile": "Sony Device",
      "category": "Electronics IoT",
      "vertical": "Generic IoT"
    },
    {
      "profile": "JK microsystems Device",
      "category": "Industrial Controller",
      "vertical": "Industrial"
    },
    {
      "profile": "Siemens PLC",
      "category": "Industrial Controller",
      "vertical": "Industrial"
    }
  ]
}

4XX

Client Error Response

application/json

Schema

Schema

code string

STATUS_CODE

msg string

GENERAL_MESSAGE

Example (from schema)

{
  "code": "string",
  "msg": "string"
}

Bad Request

{
  "code": 400,
  "msg": "Bad Request. This occurs when an HTTP request contains an invalid query string."
}

Forbidden access

{
  "code": 403,
  "msg": "Forbidden access. Either the provided API key is invalid or it does not have the required RBAC permissions to run this API."
}

Too many requests

{
  "code": 429,
  "msg": "Too many requests. The number of requests for device details for a single device exceeded the rate limit of 180 queries per minute per tenant."
}

5XX

Server Error Response

application/json

Schema

Schema

code string

STATUS_CODE

msg string

GENERAL_MESSAGE

Example (from schema)

{
  "code": "string",
  "msg": "string"
}

deviceDetailResponseExample

{
  "code": 500,
  "msg": "Internal server error. A unified status for API communication type errors."
}

Loading...