Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors See Also

GetServiceEndpoint

Gets the account-specific endpoint for Configuration and Update Server (CUPS) protocol or LoRaWAN Network Server (LNS) connections.

Request Syntax


GET /service-endpoint?serviceType=ServiceType HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

ServiceType

The service type for which to get endpoint information about. Can be CUPS for the Configuration and Update Server endpoint, or LNS for the LoRaWAN Network Server endpoint or CLAIM for the global endpoint.

Valid Values: CUPS | LNS

Request Body

The request does not have a request body.

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "ServerTrust": "string",
   "ServiceEndpoint": "string",
   "ServiceType": "string"
}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

ServerTrust

The Root CA of the server trust certificate.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 4096.

Pattern: [^-A-Za-z0-9+/=]|=[^=]|={3,}${1,4096}

ServiceEndpoint

The service endpoint value.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 256.

ServiceType

The endpoint's service type.

Type: String

Valid Values: CUPS | LNS

Errors

For information about the errors that are common to all actions, see Common Errors.

AccessDeniedException

User does not have permission to perform this action.

HTTP Status Code: 403

InternalServerException

An unexpected error occurred while processing a request.

HTTP Status Code: 500

ThrottlingException

The request was denied because it exceeded the allowed API request rate.

HTTP Status Code: 429

ValidationException

The input did not meet the specified constraints.

HTTP Status Code: 400