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 EndDeviceClaimingServer API

The EndDeviceClaimingServer API from The Things Network / The Things Stack — 5 operation(s) for enddeviceclaimingserver.

The Things Network / The Things Stack EndDeviceClaimingServer 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 EndDeviceClaimingServer. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and 9 JSON Schemas.

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

6 operations 5 paths 11 schemas 2 DELETE1 GET3 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 EndDeviceClaimingServer 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 6

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

EndDeviceClaimingServer 6
POST
/edcs/applications/{application_ids.application_id}/authorize
Authorize the End Device Claiming Server to claim devices registered in the given application. The application identifiers are the source application, where the devices are registered before they are…
EndDeviceClaimingServer_AuthorizeApplication 2 params → 200default
DELETE
/edcs/applications/{application_id}/authorize
Unauthorize the End Device Claiming Server to claim devices in the given application. This reverts the authorization given with rpc AuthorizeApplication. DEPRECATED: Device claiming that transfers de…
EndDeviceClaimingServer_UnauthorizeApplication 1 param → 200default
POST
/edcs/claim
Claims the end device on a Join Server by claim authentication code or QR code.
EndDeviceClaimingServer_Claim 1 param → 200default
POST
/edcs/claim/info
Return whether claiming is available for a given JoinEUI.
EndDeviceClaimingServer_GetInfoByJoinEUI 1 param → 200default
GET
/edcs/claim/{application_ids.application_id}/devices/{device_id}
Gets the claim status of an end device. EUIs provided in the request are ignored and the end device is looked up by the given identifiers.
EndDeviceClaimingServer_GetClaimStatus 5 params → 200default
DELETE
/edcs/claim/{application_ids.application_id}/devices/{device_id}
Unclaims the end device on a Join Server. EUIs provided in the request are ignored and the end device is looked up by the given identifiers.
EndDeviceClaimingServer_Unclaim 5 params → 200default

Schemas 11

The contract defines 11 schemas that model the data the API accepts and returns. The most detailed are v3EndDeviceIdentifiers (5 properties), v3ClaimEndDeviceRequest (4 properties), v3GetClaimStatusResponse (4 properties), googlerpcStatus (3 properties). Each schema is shown below with its type and property counts.

GetClaimStatusResponseVendorSpecific
object
2 properties
googlerpcStatus
object
3 properties
v3ClaimEndDeviceRequest
object
4 properties
EndDeviceClaimingServerAuthorizeApplicationBody
object
DEPRECATED: Device claiming that transfers devices between applications is no longer supported and will be removed in a future version of The Things Stack.
2 properties
v3ApplicationIdentifiers
object
1 property
v3EndDeviceIdentifiers
object
5 properties
v3GetInfoByJoinEUIRequest
object
1 property
v3GetClaimStatusResponse
object
4 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
v3GetInfoByJoinEUIResponse
object
2 properties
v3ClaimEndDeviceRequestAuthenticatedIdentifiers
object
3 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

the-things-network-enddeviceclaimingserver-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