Get the device by security code

Contents

Get the device details by security code.

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

Request Syntax


GET /v1/device



Request Headers

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

Value of type: string
true


Request Query Parameters

Parameter Description Required
securityCode Value of type: string true


200 Response

OK

Response Payload

Description Required
Object of type: Register false


Example

Sample request to get device details by security code.

Request


GET device/v1/device/?securityCode={securityCode} HTTP/1.1
Host: Endpoint-URL
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJ
Content-Type: application/json

Response


HTTP/1.1 200 OK
{
  "error": null,
  "data": {
    "deviceId": "string",
    "securityCode": "123ABC456",
    "modelId": "0",
    "name": "string",
    "mac": "string",
    "type": "string",
    "cloudConnected": true,
    "createdOn": "2016-11-22T22:35:12",
    "configuration": {
      "wisb": "string",
      "wiri": "string",
      "status": "string",
      "notes": "string"
    },
    "firmware": {
      "wiri": "string",
      "status": "string",
      "notes": "string"
    },
    "network": {
      "localIpAddress": "192.168.1.1",
      "externalIpAddress": "192.4.4.4",
      "internalDNSName": "192.168.1.1",
      "connectionType": 0,
      "httpPort": 0,
      "httpPortLocal": 0,
      "httpsPort": 0,
      "httpsPortLocal": 0,
      "notes": "string",
      "tunnelId": "string",
      "externalURI": "string",
      "internalURI": "http://192.168.1.1",
      "internalURL": "http://192.168.1.1",
      "tunnelBaseURI": "string",
      "proxyURL": "string",
    }
  }
}

Have question about this section?