edgehog-astarte-interfaces/io.edgehog.devicemanager.ForwarderSessionRequest.json at main · edgehog-device-manager/edgehog-astarte-interfaces · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
{
  "interface_name": "io.edgehog.devicemanager.ForwarderSessionRequest",
  "version_major": 0,
  "version_minor": 1,
  "type": "datastream",
  "ownership": "server",
  "aggregation": "object",
  "description": "Configuration to open a session with the Edgehog Forwarder from a device to a certain host.",
  "mappings": [
    {
      "endpoint": "/request/session_token",
      "type": "string",
      "database_retention_policy": "use_ttl",
      "database_retention_ttl": 31556952,
      "description": "The session token thanks to which the device can authenticates itself through Edgehog."
    },
    {
      "endpoint": "/request/port",
      "type": "integer",
      "database_retention_policy": "use_ttl",
      "database_retention_ttl": 31556952,
      "description": "The host port the device must connect to."
    },
    {
      "endpoint": "/request/host",
      "type": "string",
      "database_retention_policy": "use_ttl",
      "database_retention_ttl": 31556952,
      "description": "The IP address or host name the device must connect to."
    },
    {
      "endpoint": "/request/secure",
      "type": "boolean",
      "database_retention_policy": "use_ttl",
      "database_retention_ttl": 31556952,
      "description": "Indicates whether the connection should use TLS, i.e. 'ws' or 'wss' scheme."
    }
  ]
}