latestOpenAPI 3.1.0Apache License Version 2.02026-08-17498525913.3 KB

40169ccdec5c

edge-controller

Make edge publicly available (assignEdgeToPublicCustomer)

Edge will be available for non-authorized (not logged-in) users. This is useful to create dashboards that you plan to share/embed on a publicly available website. However, users that are logged-in and belong to different tenant will not be able to access the edge.

Available for users with 'TENANT_ADMIN' authority.

post/api/customer/public/edge/{edgeId}

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