Sign in
latestOpenAPI 3.1.0Apache License Version 2.02026-08-17498525913.3 KB

40169ccdec5c

edge-controller

Create Or Update Edge (saveEdge)

Create or update the Edge. When creating edge, platform generates Edge Id as time-based UUID. The newly created edge id will be present in the response. Specify existing Edge id to update the edge. Referencing non-existing Edge Id will cause 'Not Found' error.

Edge name is unique in the scope of tenant. Use unique identifiers like MAC or IMEI for the edge names and non-unique 'label' field for user-friendly visualization purposes.Remove 'id', 'tenantId' and optionally 'customerId' from the request body example (below) to create new Edge entity.

Available for users with 'TENANT_ADMIN' authority.

post/api/edge

Request body

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
{"stackTrail":"components:schemas:JsonNode","oasType":"schema","type":"unknown","description":"A value representing the any type (object or primitive)","example":{}}

Example request

{
  "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": {}
}

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
{"stackTrail":"components:schemas:JsonNode","oasType":"schema","type":"unknown","description":"A value representing the any type (object or primitive)","example":{}}

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": {}
}