Documentation

Modify device

Description

Modify a specific device configuration.

Request

POST /v1/n5/products/:productId/devices/:deviceId

{
  name?: string|null,
  fingerprint?: string|null,
  tags?: {
    [key: string]: string
  }
}

Response

Successful response contains the following JSON formated body:

{
   productId: string,
  deviceId: string,
  name: string|null,
  batchId: number,
  fingerprint: string|null,
  created: string,
  tags: {
    [key: string]: string
  },
  deleted: boolean,
  attached: boolean,
  lastAttach?: string|null,
  lastDetach?: string|null
}

Response Status codes:

  • 200 on success

Request headers

This request must have the following headers:

  • Authorization: bearer <ApiKey>
  • X-Nabto-Organization: <organizationId>
  • Content-Type: application/json

Example

Request

curl -XPOST "https://api.cloud.nabto.com/v1/n5/products/:productId/devices/:deviceId" \
  -H "Authorization: Bearer <ApiKey>" \
  -H "X-Nabto-Organization: <OrganizationId>" \
  -H "Content-Type: application/json" \
  -d '{ name: "friendly name", fingerprint: "0123456789abcdef0123456789abcdef0123456789abcdef0123456789abcdef", tags: {"foo": "bar" }}'

Response

{
   productId: "pr-abcdefgh",
  deviceId: "de-efghijkl",
  name: "friendly name",
  batchId: 42,
  fingerprint: "0123456789abcdef0123456789abcdef0123456789abcdef0123456789abcdef",
  created: "2022-10-18T10:17:24.299Z",
  tags: {
    "foo": "bar" 
  },
  deleted: true,
  attached: true,
  lastAttach: "<lastAttach>",
  lastDetach: "<lastDetach>"
}