CoAP GET /tcp-tunnels/services/:serviceId

DESCRIPTION

This endpoint provides detailed information about a particular TCP tunnel service available on the device.

GET /tcp-tunnels/services/:serviceId

Request body is empty.

CoAP status codes:

Response body is a CBOR object describing the service:

{
  "Id": "local-ssh",
  "Type": "ssh"
  "Port": 22,
  "Host": "127.0.0.1",
  "StreamPort": <uint32_t>
}

Id:: The ID matching the provided serviceId parameter.
Type:: The service type used to group services to ease access decisions.
Port:: The port number the TCP socket in the device will connect to when a TCP connection is established through the tunnel.
Host:: The host the TCP socket in the device will connect to when a TCP connection is established through the tunnel.
StreamPort:: The stream port the client should use when opening the tunnel. This is handled internally when using the [Tunnelling API](/developer/api-reference/plain-c-client-sdk/tcp_tunnelling/Introduction.html) in the client..

This endpoint generates an Authorization request with the following Action which must be allowed for this endpoint to be available:

The following attributes is available in the Authorization request: