Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

The Things Network / The Things Stack GatewayClaimingServer API

The GatewayClaimingServer API from The Things Network / The Things Stack — 5 operation(s) for gatewayclaimingserver.

The Things Network / The Things Stack GatewayClaimingServer API is one of 58 APIs that The Things Network / The Things Stack publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

This API exposes 9 JSON Schema definitions.

Tagged areas include GatewayClaimingServer. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and 9 JSON Schemas.

This API exposes 5 operations across 5 paths, and defines 13 schemas. It is described by OpenAPI 2.0, at version v3.36.

5 operations 5 paths 13 schemas 2 DELETE3 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 2.0
API Version
v3.36
Authentication
API Key
License
Resource Areas
1

Authentication & Security 1

The Things Network / The Things Stack GatewayClaimingServer API declares 1 security scheme for authenticating requests. An API key is passed in the header as Authorization (ApiKeyAuth). By default, every request must be authenticated.

  • ApiKeyAuth — Bearer API key. Set Authorization: Bearer NNSXS.xxxxxxxxxx.

Paths & Operations 5

Across 5 paths, the API surfaces 5 operations — 2 DELETE, 3 POST. Each is listed below with its method, path, parameters, and response codes.

GatewayClaimingServer 5
POST
/gcls/claim
Claims a gateway by claim authentication code or QR code and transfers the gateway to the target user.
GatewayClaimingServer_Claim 1 param → 200default
POST
/gcls/claim/info
Return whether claiming is available for a given gateway EUI.
GatewayClaimingServer_GetInfoByGatewayEUI 1 param → 200default
DELETE
/gcls/claim/{gateway_id}
Unclaims the gateway. EUI provided in the request are ignored and the end device is looked up by the gateway ID.
GatewayClaimingServer_Unclaim 2 params → 200default
POST
/gcls/gateways/{gateway_ids.gateway_id}/authorize
AuthorizeGateway allows a gateway to be claimed. DEPRECATED: Authorizing gateways for claiming is no longer supported and will be removed in a future version of The Things Stack.
GatewayClaimingServer_AuthorizeGateway 2 params → 200default
DELETE
/gcls/gateways/{gateway_id}/authorize
UnauthorizeGateway prevents a gateway from being claimed. DEPRECATED: Unauthorizing (locking) gateways for claiming is no longer supported and will be removed in a future version of The Things Stack.
GatewayClaimingServer_UnauthorizeGateway 2 params → 200default

Schemas 13

The contract defines 13 schemas that model the data the API accepts and returns. The most detailed are v3ClaimGatewayRequest (8 properties), v3CUPSRedirection (5 properties), v3GetInfoByGatewayEUIResponse (3 properties), googlerpcStatus (3 properties). Each schema is shown below with its type and property counts.

v3ClaimGatewayRequest
object
8 properties
googlerpcStatus
object
3 properties
v3GetInfoByGatewayEUIRequest
object
1 property
v3CUPSRedirection
object
DEPRECATED: This message is deprecated and will be removed in a future version of The Things Stack.
5 properties
v3ClaimGatewayRequestAuthenticatedIdentifiers
object
2 properties
CUPSRedirectionClientTLS
object
2 properties
lorawanv3GatewayIdentifiers
object
2 properties
v3GetInfoByGatewayEUIResponse
object
3 properties
v3UserIdentifiers
object
2 properties
GatewayClaimingServerAuthorizeGatewayBody
object
2 properties
protobufAny
object
Any contains an arbitrary serialized protocol buffer message along with a URL that describes the type of the serialized message. Protobuf library provides supp…
1 property
v3OrganizationOrUserIdentifiers
object
OrganizationOrUserIdentifiers contains either organization or user identifiers.
2 properties
v3OrganizationIdentifiers
object
1 property

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

the-things-network-gatewayclaimingserver-api-openapi.yml Raw ↑

Other APIs The Things Network / The Things Stack publishes across the network.

The Things Network / The Things Stack AppAs API
The Things Network / The Things Stack ApplicationAccess API
The Things Network / The Things Stack ApplicationActivationSettingRegistry API
The Things Network / The Things Stack ApplicationPackageRegistry API
The Things Network / The Things Stack ApplicationPubSubRegistry API
The Things Network / The Things Stack ApplicationRegistry API
The Things Network / The Things Stack ApplicationUpStorage API
The Things Network / The Things Stack ApplicationWebhookRegistry API
The Things Network / The Things Stack As API
The Things Network / The Things Stack AsEndDeviceBatchRegistry API
The Things Network / The Things Stack AsEndDeviceRegistry API
The Things Network / The Things Stack ClientAccess API