How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
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 3.2.0, at version v3.36.

Requests are made against a single base URL, https://eu1.cloud.thethings.industries/api/v3.

4 operations 4 paths 50 schemas 4 GET

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
v3.36
Base URL
https://eu1.cloud.thethings.network/api/v3
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.

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

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
Where this information came from

This is an independent, third-party profile of The Things Network / The Things Stack Ns API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.