Skip to main content
POST
/
devices
/
names
Update device names (bulk)
curl --request POST \
  --url https://dashboard.hologram.io/api/1/devices/names \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "prefix": "<string>",
  "skipPostfix": true,
  "deviceids": [
    123
  ],
  "allSelected": true,
  "useSearch": true,
  "deviceFilters": {
    "limit": 123,
    "pageIdsSelected": [
      123
    ],
    "pagesSelected": [
      123
    ],
    "states": [
      "<string>"
    ],
    "hitsPerPage": 123,
    "orgid": 123,
    "query": "<string>",
    "sort": {},
    "filters": {}
  },
  "excludedDeviceIds": [
    123
  ],
  "linkids": [
    123
  ],
  "pagesSelected": [
    123
  ]
}
'
{
  "success": true
}

Authorizations

Authorization
string
header
required

HTTP Basic authentication using API keys. Set the username to apikey and the password to your API key. You can find your API key on the Hologram Dashboard under Account Settings.

Query Parameters

preview
boolean

When true, return a sample of devices that would be renamed without making changes

Body

application/json
prefix
string
required

String prepended to every renamed device. The last 5 digits of the active ICCID are appended in parentheses unless skipPostfix is true.

skipPostfix
boolean

When true, set each device name to the prefix exactly, with no ICCID suffix appended.

deviceids
integer[]

Explicit list of device IDs to rename.

allSelected
boolean

When true, select all devices in the organization (subject to excludedDeviceIds).

When true, resolve the device selection from the search index using deviceFilters instead of the database.

deviceFilters
object

Filter criteria used to select devices when allSelected is true or useSearch is true.

excludedDeviceIds
integer[]

Device IDs to exclude from the bulk selection.

linkids
integer[]

Cellular link IDs to include in the selection.

pagesSelected
integer[]

Top-level page numbers selected; presence triggers bulk device selection.

Response

OK

success
boolean

Indicates whether the request was successful.

Example:

true