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

The AppAs API from The Things Network / The Things Stack — 8 operation(s) for appas.

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

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

8 operations 8 paths 46 schemas 2 GET6 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 AppAs 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 8

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

AppAs 8
GET
/as/applications/{application_ids.application_id}/devices/{device_id}/down
List the items currently in the downlink queue.
AppAs_DownlinkQueueList 5 params → 200default
GET
/as/applications/{application_id}/mqtt-connection-info
Get connection information to connect an MQTT client.
AppAs_GetMQTTConnectionInfo 1 param → 200default
POST
/as/applications/{end_device_ids.application_ids.application_id}/devices/{end_device_ids.device_id}/down/decode
AppAs_DecodeDownlink 3 params → 200default
POST
/as/applications/{end_device_ids.application_ids.application_id}/devices/{end_device_ids.device_id}/down/encode
AppAs_EncodeDownlink 3 params → 200default
POST
/as/applications/{end_device_ids.application_ids.application_id}/devices/{end_device_ids.device_id}/down/push
Push downlink messages to the end of the downlink queue.
AppAs_DownlinkQueuePush 3 params → 200default
POST
/as/applications/{end_device_ids.application_ids.application_id}/devices/{end_device_ids.device_id}/down/replace
Replace the entire downlink queue with the specified messages. This can also be used to empty the queue by specifying no messages.
AppAs_DownlinkQueueReplace 3 params → 200default
POST
/as/applications/{end_device_ids.application_ids.application_id}/devices/{end_device_ids.device_id}/up/decode
AppAs_DecodeUplink 3 params → 200default
POST
/as/applications/{end_device_ids.application_ids.application_id}/devices/{end_device_ids.device_id}/up/simulate
Simulate an upstream message. This can be used to test integrations.
AppAs_SimulateUplink 3 params → 200default

Schemas 46

The contract defines 46 schemas that model the data the API accepts and returns. The most detailed are lorawanv3RxMetadata (24 properties), v3ApplicationUplink (21 properties), v3ApplicationUplinkNormalized (15 properties), AppAsSimulateUplinkBody (15 properties). Each schema is shown below with its type and property counts.

v3LoRaDataRate
object
3 properties
AppAsSimulateUplinkBody
object
Application uplink message.
15 properties
lorawanv3RxMetadata
object
Contains metadata for a received message. Each antenna that receives a message corresponds to one RxMetadata.
24 properties
v3ApplicationDownlink
object
15 properties
v3ApplicationUplink
object
21 properties
v3TxSchedulePriority
string
v3LocationSource
string
- SOURCEUNKNOWN: The source of the location is not known or not set. - SOURCEGPS: The location is determined by GPS. - SOURCEREGISTRY: The location is set in a…
v3ApplicationLocation
object
3 properties
v3ClassBCGatewayIdentifiers
object
3 properties
lorawanv3GatewayIdentifiers
object
2 properties
v3MQTTConnectionInfo
object
The connection information of an MQTT frontend.
3 properties
v3NetworkIdentifiers
object
Identifies a Network Server.
6 properties
v3EncodeDownlinkResponse
object
1 property
v3LastBatteryPercentage
object
3 properties
v3PayloadFormatter
string
- FORMATTERNONE: No payload formatter to work with raw payload only. - FORMATTERREPOSITORY: Use payload formatter for the end device type from a repository. -…
ApplicationDownlinkClassBC
object
2 properties
lorawanv3Location
object
5 properties
v3ApplicationDownlinks
object
1 property
v3KeyEnvelope
object
3 properties
AppAsDecodeDownlinkBody
object
5 properties
v3PacketBrokerRouteHop
object
5 properties
v3DataRate
object
3 properties
v3FSKDataRate
object
1 property
v3DownlinkPathConstraint
string
- DOWNLINKPATHCONSTRAINTNONE: Indicates that the gateway can be selected for downlink without constraints by the Network Server. - DOWNLINKPATHCONSTRAINTPREFER…
v3ApplicationUplinkNormalized
object
15 properties
v3ApplicationServiceData
object
6 properties
v3ApplicationDownlinkFailed
object
6 properties
AppAsEncodeDownlinkBody
object
5 properties
v3AppAsDownlinkQueueReplaceBody
object
2 properties
lorawanv3TxSettings
object
TxSettings contains the settings for a transmission. This message is used on both uplink and downlink. On downlink, this is a scheduled transmission.
7 properties
v3LRFHSSDataRate
object
3 properties
TxSettingsDownlink
object
Transmission settings for downlink.
3 properties
lorawanv3PacketBrokerMetadata
object
10 properties
v3DecodeDownlinkResponse
object
1 property
googlerpcStatus
object
3 properties
ApplicationDownlinkConfirmedRetry
object
2 properties
v3DecodeUplinkResponse
object
1 property
v3AppAsDownlinkQueuePushBody
object
2 properties
v3EndDeviceVersionIdentifiers
object
Identifies an end device model with version information.
5 properties
lorawanv3RelayWORChannel
string
v3ApplicationJoinAccept
object
9 properties
AppAsDecodeUplinkBody
object
5 properties
lorawanv3RelayMetadata
object
2 properties
v3ApplicationInvalidatedDownlinks
object
7 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
v3ErrorDetails
object
Error details that are communicated over gRPC (and HTTP) APIs. The messages (for translation) are stored as "error: : ".
8 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

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

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

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
The Things Network / The Things Stack ClientRegistry API