Bulk Device Updates - Custom Attribute

Update devices custom attributes values

Query Parameters

customerid string required

The customer ID to which the API call is directed

updateSource string required

Possible values: [customAttribute]

The source of the device information: Custom Attribute

application/json

Request Body required

devicelist object[] required
Array of device custom attributes from users to update custom attribute values
Array [
deviceid string
The device ID, which IoT Security uses to identify and track a device.
tagType string
The custom attribute name. The custom attribute should already exist in the IoT Security.
tagValue string
The value of the custom attribute.
]

Responses

• 200
• 4XX
• 5XX

---

Successful Response

application/json

Schema

Example (from schema)

resolveSecurityAlertResponseExample

---

Schema

api string

The path used to call the IoT Security API: “device/bulkupdate”

ver string

The version of the IoT Security API: “v4.0”

code string

The code number indicating success: 1

message string

The message indicating success: “OK”

updatedAttributesNum integer

The number of attributes that IoT Security successfully updated

errorCases Object

The cases that are not valid to update custom attribute

{
  "api": "string",
  "ver": "string",
  "code": "string",
  "message": "string",
  "updatedAttributesNum": 0
}

{
  "api": "device/bulkUpdate",
  "ver": "v4.0",
  "code": 1,
  "message": "OK",
  "updatedAttributesNum": 4,
  "errorCases": {}
}

Client Error Response

application/json

Schema

Example (from schema)

Bad Request

Forbidden access

Too many requests

---

Schema

code string

STATUS_CODE

msg string

GENERAL_MESSAGE

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

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

{
  "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."
}

{
  "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."
}

Server Error Response

application/json

Schema

Example (from schema)

resolveSecurityAlertResponseExample

---

Schema

code string

STATUS_CODE

msg string

GENERAL_MESSAGE

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

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

Loading...