THthingsboard
edge-controller

Get Edge (getEdgeById)

Get the Edge object based on the provided Edge Id. If the user has the authority of 'Tenant Administrator', the server checks that the edge is owned by the same tenant. If the user has the authority of 'Customer User', the server checks that the edge is assigned to the same customer.

Available for users with 'TENANT_ADMIN' or 'CUSTOMER_USER' authority.

get/api/edge/{edgeId}

Request

Path parameters

edgeIdstring required

A string value representing the edge id. For example, '784f394c-42b6-435a-983c-b7beff2784f9'

Response

OK

createdTimeinteger

Timestamp of the edge creation, in milliseconds

namestring required

Unique Edge Name in scope of Tenant

typestring required

Edge type

labelstring

Label that may be used in widgets

routingKeystring required

Edge routing key ('username') to authorize on cloud

secretstring required

Edge secret ('password') to authorize on cloud

versioninteger
additionalInfounknown

Example response

{
  "id": {
    "id": "784f394c-42b6-435a-983c-b7beff2784f9",
    "entityType": "EDGE"
  },
  "createdTime": 1609459200000,
  "tenantId": {
    "id": "784f394c-42b6-435a-983c-b7beff2784f9",
    "entityType": "TENANT"
  },
  "customerId": {
    "id": "784f394c-42b6-435a-983c-b7beff2784f9",
    "entityType": "CUSTOMER"
  },
  "rootRuleChainId": {
    "id": "784f394c-42b6-435a-983c-b7beff2784f9",
    "entityType": "RULE_CHAIN"
  },
  "name": "Silo_A_Edge",
  "type": "Silos",
  "label": "Silo Edge on far field",
  "additionalInfo": {}
}

Changes

No recorded changes to this operation across all 2 revisions of this API.