Get the Device

Contents

Get the device based on ID.

Endpoint URL: {service.device.url} received in EndpointFetching

Request Syntax


GET /v1/device/{deviceId}



Request Headers

Parameter Description Required
Authorization Authorization token in the form "Bearer {token}."

Value of type: string
true


Request Path Parameters

Parameter Description Required
deviceId Value of type: string true


200 Response

OK

Response Payload

Description Required
Object of type: Device false


Example

Sample request to get device details by Device ID.

Request


GET device/v1/device/{deviceId} HTTP/1.1
Host: Endpoint-URL
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJ

Response


[
    {
       "data": {
           "deviceId": "string",
           "modelId": "0",
           "name": "User's My Cloud Home",
           "mac": "string",
           "type": "string",
           "cloudConnected": true,
           "createdOn": "2017-10-09T18:54:16",
           "attachedStatus": "APPROVED",
           "configuration": {
               "wisb": "string",
               "wiri": "string"
           },
           "firmware": {
               "wiri": "string"
           },
           "network": {
               "localIpAddress": "string",
               "externalIpAddress": "string",
               "internalDNSName": "string",
               "connectionType": 0,
               "httpPort": -1,
               "portForwardPort": -1,
               "tunnelId": "string",
               "externalURI": "string",
               "internalURI": "string",
               "internalURL": "string",
               "proxyURL": "string"
           },
           "sendOTANotification": true,
           "lang": "en",
           "ownerAccess": true
       }
   }
]

Have question about this section?