GET api/gateways/{id}/endpoints?UseIPv6={UseIPv6}

Gets the endpoints for a gateway. For use by gateways.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
id

Id of the gateway to get endpoints for.

string

Required

UseIPv6

boolean

Default value is False

Body Parameters

None.

Response Information

Resource Description

Information about the endpoints.

EndpointResponse
NameDescriptionTypeAdditional information
GatewayId

globally unique identifier

None.

TelemetryUrl

string

None.

TelemetrySAStoken

string

None.

ControlConnectionString

string

None.

Response Formats

application/json, text/json

Sample:
{
  "GatewayId": "551589a1-9520-42f8-932b-6f643f3c677d",
  "TelemetryUrl": "sample string 2",
  "TelemetrySAStoken": "sample string 3",
  "ControlConnectionString": "sample string 4"
}

application/xml, text/xml

Sample:
<EndpointResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/eSmart.Backend.Service.IoTManagement.Models">
  <ControlConnectionString>sample string 4</ControlConnectionString>
  <GatewayId>551589a1-9520-42f8-932b-6f643f3c677d</GatewayId>
  <TelemetrySAStoken>sample string 3</TelemetrySAStoken>
  <TelemetryUrl>sample string 2</TelemetryUrl>
</EndpointResponse>