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

The ApplicationRegistry API from The Things Network / The Things Stack — 9 operation(s) for applicationregistry.

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

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

11 operations 9 paths 14 schemas 2 DELETE4 GET4 POST1 PUT

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 ApplicationRegistry 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 11

Across 9 paths, the API surfaces 11 operations — 2 DELETE, 4 GET, 4 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

ApplicationRegistry 11
GET
/applications
List applications where the given user or organization is a direct collaborator. If no user or organization is given, this returns the applications the caller has access to. Similar to Get, this sele…
ApplicationRegistry_List 8 params → 200default
PUT
/applications/{application.ids.application_id}
Update the application, changing the fields specified by the field mask to the provided values.
ApplicationRegistry_Update 2 params → 200default
GET
/applications/{application_ids.application_id}
Get the application with the given identifiers, selecting the fields specified in the field mask. More or less fields may be returned, depending on the rights of the caller.
ApplicationRegistry_Get 2 params → 200default
DELETE
/applications/{application_id}
Delete the application. This may not release the application ID for reuse. All end devices must be deleted from the application before it can be deleted.
ApplicationRegistry_Delete 1 param → 200default
POST
/applications/{application_id}/dev-eui
Request DevEUI from the configured address block for a device inside the application. The maximum number of DevEUI's issued per application can be configured.
ApplicationRegistry_IssueDevEUI 1 param → 200default
DELETE
/applications/{application_id}/purge
Purge the application. This will release the application ID for reuse. All end devices must be deleted from the application before it can be deleted. The application owner is responsible for clearing…
ApplicationRegistry_Purge 1 param → 200default
POST
/applications/{application_id}/restore
Restore a recently deleted application.
ApplicationRegistry_Restore 1 param → 200default
GET
/organizations/{collaborator.organization_ids.organization_id}/applications
List applications where the given user or organization is a direct collaborator. If no user or organization is given, this returns the applications the caller has access to. Similar to Get, this sele…
ApplicationRegistry_List3 8 params → 200default
POST
/organizations/{collaborator.organization_ids.organization_id}/applications
Create a new application. This also sets the given organization or user as first collaborator with all possible rights.
ApplicationRegistry_Create2 2 params → 200default
GET
/users/{collaborator.user_ids.user_id}/applications
List applications where the given user or organization is a direct collaborator. If no user or organization is given, this returns the applications the caller has access to. Similar to Get, this sele…
ApplicationRegistry_List2 8 params → 200default
POST
/users/{collaborator.user_ids.user_id}/applications
Create a new application. This also sets the given organization or user as first collaborator with all possible rights.
ApplicationRegistry_Create 2 params → 200default

Schemas 14

The contract defines 14 schemas that model the data the API accepts and returns. The most detailed are v3Application (14 properties), v3ContactInfo (5 properties), googlerpcStatus (3 properties), v3ApplicationRegistryUpdateBody (2 properties). Each schema is shown below with its type and property counts.

googlerpcStatus
object
3 properties
v3Application
object
Application is the message that defines an Application in the network.
14 properties
v3ContactMethod
string
v3ApplicationRegistryCreateBody
object
2 properties
v3IssueDevEUIResponse
object
1 property
v3ApplicationIdentifiers
object
1 property
v3ApplicationRegistryUpdateBody
object
2 properties
v3ContactType
string
v3Applications
object
1 property
v3UserIdentifiers
object
2 properties
v3ContactInfo
object
5 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-applicationregistry-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 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
The Things Network / The Things Stack ClientRegistry API