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

The Ns API from The Things Network / The Things Stack — 4 operation(s) for ns.

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

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

4 operations 4 paths 50 schemas 4 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 Ns 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 4

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

Ns 4
GET
/ns/default_mac_settings/{frequency_plan_id}/{lorawan_phy_version}
GetDefaultMACSettings retrieves the default MAC settings for a frequency plan.
Ns_GetDefaultMACSettings 2 params → 200default
GET
/ns/dev_addr
GenerateDevAddr requests a device address assignment from the Network Server.
Ns_GenerateDevAddr → 200default
GET
/ns/dev_addr_prefixes
Ns_GetDeviceAddressPrefixes → 200default
GET
/ns/net_id
Ns_GetNetID → 200default

Schemas 50

The contract defines 50 schemas that model the data the API accepts and returns. The most detailed are v3MACSettings (36 properties), DynamicModeOverrides (16 properties), ADRSettingsDynamicMode (9 properties), v3ServedRelaySettings (6 properties). Each schema is shown below with its type and property counts.

v3RelayLimitBucketSize
string
v3ADRAckLimitExponent
string
v3ADRAckLimitExponentValue
object
1 property
ChannelSteeringSettingsLoRaNarrowMode
object
Configuration options for LoRa narrow channels steering. The narrow mode attempts to steer the end device towards using the LoRa modulated, 125kHz bandwidth ch…
DynamicModeOverrides
object
EXPERIMENTAL: Configuration overrides.
16 properties
v3RelayEndDeviceControlledMode
object
v3RelayForwardLimits
object
2 properties
DynamicModeChannelSteeringSettingsDisabledMode
object
Configuration options for cases in which ADR is not supposed to steer the end device to another set of channels.
v3ADRSettingsDisabledMode
object
Configuration options for cases in which ADR is to be disabled completely.
v3RxDelay
string
- RXDELAY0: 1 second. - RXDELAY1: 1 second. - RXDELAY2: 2 seconds. - RXDELAY3: 3 seconds. - RXDELAY4: 4 seconds. - RXDELAY5: 5 seconds. - RXDELAY6: 6 seconds.…
v3FrequencyValue
object
1 property
ADRSettingsDynamicMode
object
Configuration options for dynamic ADR.
9 properties
v3DataRateIndex
string
v3RelayUplinkForwardingRule
object
4 properties
v3ServingRelayForwardingLimits
object
5 properties
DynamicModePerDataRateIndexOverride
object
EXPERIMENTAL: Data rate index override settings.
2 properties
v3GenerateDevAddrResponse
object
Response of GenerateDevAddr.
1 property
v3PingSlotPeriod
string
- PINGEVERY1S: Every second. - PINGEVERY2S: Every 2 seconds. - PINGEVERY4S: Every 4 seconds. - PINGEVERY8S: Every 8 seconds. - PINGEVERY16S: Every 16 seconds.…
v3DeviceEIRP
string
- DEVICEEIRP8: 8 dBm. - DEVICEEIRP10: 10 dBm. - DEVICEEIRP12: 12 dBm. - DEVICEEIRP13: 13 dBm. - DEVICEEIRP14: 14 dBm. - DEVICEEIRP16: 16 dBm. - DEVICEEIRP18: 1…
v3RelaySecondChannel
object
3 properties
v3RelayEndDeviceDynamicMode
object
1 property
v3ZeroableFrequencyValue
object
1 property
ADRSettingsStaticMode
object
Configuration options for static ADR.
3 properties
v3ADRSettings
object
Adaptive Data Rate settings.
3 properties
v3DataRateIndexValue
object
1 property
v3AggregatedDutyCycle
string
- DUTYCYCLE1: 100%. - DUTYCYCLE2: 50%. - DUTYCYCLE4: 25%. - DUTYCYCLE8: 12.5%. - DUTYCYCLE16: 6.25%. - DUTYCYCLE32: 3.125%. - DUTYCYCLE64: 1.5625%. - DUTYCYCLE…
v3PingSlotPeriodValue
object
1 property
v3MACSettings
object
36 properties
v3DeviceEIRPValue
object
1 property
v3ADRAckDelayExponentValue
object
1 property
v3RelayUplinkForwardLimits
object
2 properties
v3AggregatedDutyCycleValue
object
1 property
v3GetDeviceAdressPrefixesResponse
object
1 property
lorawanv3BoolValue
object
1 property
v3RelayEndDeviceAlwaysMode
object
v3DataRateOffsetValue
object
1 property
v3RelayResetLimitCounter
string
v3ServingRelaySettings
object
5 properties
googlerpcStatus
object
3 properties
v3ADRAckDelayExponent
string
v3GetNetIDResponse
object
1 property
v3RelaySecondChAckOffset
string
v3RelaySmartEnableLevel
string
v3DataRateOffset
string
v3RelaySettings
object
RelaySettings represent the settings of a relay. This is used internally by the Network Server.
2 properties
v3ServedRelaySettings
object
6 properties
DynamicModeChannelSteeringSettings
object
EXPERIMENTAL: Channel steering settings.
2 properties
v3RelayCADPeriodicity
string
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
v3RxDelayValue
object
1 property

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

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