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

The As API from The Things Network / The Things Stack — 4 operation(s) for as.

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

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

5 operations 4 paths 13 schemas 1 DELETE3 GET1 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 As 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 4 paths, the API surfaces 5 operations — 1 DELETE, 3 GET, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

As 5
GET
/as/applications/{application_ids.application_id}/link
Get a link configuration from the Application Server to Network Server. This only contains the configuration. Use GetLinkStats to view statistics and any link errors.
As_GetLink 2 params → 200default
PUT
/as/applications/{application_ids.application_id}/link
Set a link configuration from the Application Server a Network Server. This call returns immediately after setting the link configuration; it does not wait for a link to establish. To get link statis…
As_SetLink 2 params → 200default
DELETE
/as/applications/{application_id}/link
Delete the link between the Application Server and Network Server for the specified application.
As_DeleteLink 1 param → 200default
GET
/as/applications/{application_id}/link/stats
GetLinkStats returns the link statistics. This call returns a NotFound error code if there is no link for the given application identifiers. This call returns the error code of the link error if link…
As_GetLinkStats 1 param → 200default
GET
/as/configuration
As_GetConfiguration → 200default

Schemas 13

The contract defines 13 schemas that model the data the API accepts and returns. The most detailed are v3ApplicationLinkStats (6 properties), v3MessagePayloadFormatters (4 properties), googlerpcStatus (3 properties), AsSetLinkBody (3 properties). Each schema is shown below with its type and property counts.

v3PayloadFormatter
string
- FORMATTERNONE: No payload formatter to work with raw payload only. - FORMATTERREPOSITORY: Use payload formatter for the end device type from a repository. -…
PubSubProvidersStatus
string
- ENABLED: No restrictions are in place. - WARNING: Warnings are being emitted that the provider will be deprecated in the future. - DISABLED: New integrations…
googlerpcStatus
object
3 properties
AsConfigurationWebhooks
object
2 properties
AsConfigurationPubSub
object
1 property
v3MessagePayloadFormatters
object
4 properties
v3ApplicationLink
object
2 properties
v3GetAsConfigurationResponse
object
1 property
v3AsConfiguration
object
Application Server configuration.
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
v3ApplicationLinkStats
object
Link stats as monitored by the Application Server.
6 properties
AsSetLinkBody
object
3 properties
PubSubProviders
object
2 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

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