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

The Configuration API from The Things Network / The Things Stack — 5 operation(s) for configuration.

The Things Network / The Things Stack Configuration 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 Configuration. 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 25 schemas. It is described by OpenAPI 2.0, at version v3.36.

5 operations 5 paths 25 schemas 5 GET

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 Configuration 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 — 5 GET. Each is listed below with its method, path, parameters, and response codes.

Configuration 5
GET
/configuration/bands
Configuration_ListBands 2 params → 200default
GET
/configuration/bands/{band_id}
Configuration_ListBands2 2 params → 200default
GET
/configuration/bands/{band_id}/{phy_version}
Configuration_ListBands3 2 params → 200default
GET
/configuration/frequency-plans
Configuration_ListFrequencyPlans 3 params → 200default
GET
/configuration/phy-versions
Returns a list of supported LoRaWAN PHY Versions for the given Band ID.
Configuration_GetPhyVersions 1 param → 200default

Schemas 25

The contract defines 25 schemas that model the data the API accepts and returns. The most detailed are v3BandDescription (30 properties), v3FrequencyPlanDescription (5 properties), BandDescriptionSubBandParameters (4 properties), googlerpcStatus (3 properties). Each schema is shown below with its type and property counts.

v3LoRaDataRate
object
3 properties
ListBandsResponseVersionedBandDescription
object
1 property
v3ADRAckLimitExponent
string
BandDescriptionSubBandParameters
object
4 properties
BandDescriptionDwellTime
object
2 properties
v3DataRateIndex
string
BandDescriptionBandDataRate
object
1 property
v3CFListType
string
BandDescriptionRx2Parameters
object
2 properties
v3BandDescriptionChannel
object
3 properties
v3FrequencyPlanDescription
object
5 properties
v3ListBandsResponse
object
1 property
v3DataRate
object
3 properties
v3FSKDataRate
object
1 property
v3PHYVersion
string
BandDescriptionRelayParametersRelayWORChannel
object
3 properties
v3LRFHSSDataRate
object
3 properties
GetPhyVersionsResponseVersionInfo
object
2 properties
BandDescriptionBeacon
object
3 properties
googlerpcStatus
object
3 properties
v3GetPhyVersionsResponse
object
1 property
v3BandDescription
object
30 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
v3BandDescriptionRelayParameters
object
1 property
v3ListFrequencyPlansResponse
object
1 property

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

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