Bulk Device Updates - Cellular Devices

PUT 
/pub/v4.0/device/bulkUpdate?updateSource=cellular

Bulk device updates for cellular devices

Request

Query Parameters

customerid stringrequired

The customer ID to which the API call is directed

updateSource stringrequired

Source of integration

application/json

Body

required

devicelist object[]required
devices
Array [
ipAddress string
ipv6Address string
imei string
iccid string
imsi string
apn string
msisdn string
SessionEvtType string
]

Responses

200

Successful Response

application/json

Schema

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”

updatedDeviceNum integer

The number of devices that IoT Security successfully updated

Example (from schema)

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

resolveSecurityAlertResponseExample

{
  "api": "device/bulkUpdate",
  "ver": "v4.0",
  "code": 1,
  "message": "OK",
  "updatedDeviceNum": 5
}

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

resolveSecurityAlertResponseExample

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

Loading...