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

The NsRelayConfigurationService API from The Things Network / The Things Stack — 4 operation(s) for nsrelayconfigurationservice.

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

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

9 operations 4 paths 32 schemas 2 DELETE3 GET2 POST2 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 NsRelayConfigurationService 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 9

Across 4 paths, the API surfaces 9 operations — 2 DELETE, 3 GET, 2 POST, 2 PUT. Each is listed below with its method, path, parameters, and response codes.

NsRelayConfigurationService 9
POST
/ns/applications/{end_device_ids.application_ids.application_id}/relays
Create a relay.
NsRelayConfigurationService_CreateRelay 2 params → 200default
GET
/ns/applications/{end_device_ids.application_ids.application_id}/relays/{end_device_ids.device_id}
Get a relay.
NsRelayConfigurationService_GetRelay 6 params → 200default
DELETE
/ns/applications/{end_device_ids.application_ids.application_id}/relays/{end_device_ids.device_id}
Delete a relay.
NsRelayConfigurationService_DeleteRelay 5 params → 200default
PUT
/ns/applications/{end_device_ids.application_ids.application_id}/relays/{end_device_ids.device_id}
Update a relay.
NsRelayConfigurationService_UpdateRelay 3 params → 200default
GET
/ns/applications/{end_device_ids.application_ids.application_id}/relays/{end_device_ids.device_id}/uplink-forwarding-rules
List uplink forwarding rules.
NsRelayConfigurationService_ListRelayUplinkForwardingRules 6 params → 200default
POST
/ns/applications/{end_device_ids.application_ids.application_id}/relays/{end_device_ids.device_id}/uplink-forwarding-rules
Create an uplink forwarding rule.
NsRelayConfigurationService_CreateRelayUplinkForwardingRule 3 params → 200default
GET
/ns/applications/{end_device_ids.application_ids.application_id}/relays/{end_device_ids.device_id}/uplink-forwarding-rules/{index}
Get an uplink forwarding rule.
NsRelayConfigurationService_GetRelayUplinkForwardingRule 7 params → 200default
DELETE
/ns/applications/{end_device_ids.application_ids.application_id}/relays/{end_device_ids.device_id}/uplink-forwarding-rules/{index}
Delete an uplink forwarding rule.
NsRelayConfigurationService_DeleteRelayUplinkForwardingRule 6 params → 200default
PUT
/ns/applications/{end_device_ids.application_ids.application_id}/relays/{end_device_ids.device_id}/uplink-forwarding-rules/{index}
Update an uplink forwarding rule.
NsRelayConfigurationService_UpdateRelayUplinkForwardingRule 4 params → 200default

Schemas 32

The contract defines 32 schemas that model the data the API accepts and returns. The most detailed are v3ServedRelaySettings (6 properties), v3ServingRelayForwardingLimits (5 properties), v3ServingRelaySettings (5 properties), v3RelayUplinkForwardingRule (4 properties). Each schema is shown below with its type and property counts.

v3RelayLimitBucketSize
string
NsRelayConfigurationServiceUpdateRelayUplinkForwardingRuleBody
object
3 properties
v3UpdateRelayUplinkForwardingRuleResponse
object
1 property
v3RelayEndDeviceControlledMode
object
v3RelayForwardLimits
object
2 properties
NsRelayConfigurationServiceCreateRelayBody
object
2 properties
v3DataRateIndex
string
v3DeleteRelayUplinkForwardingRuleResponse
object
v3RelayUplinkForwardingRule
object
4 properties
v3ServingRelayForwardingLimits
object
5 properties
v3DeleteRelayResponse
object
v3GetRelayResponse
object
1 property
v3RelaySecondChannel
object
3 properties
v3RelayEndDeviceDynamicMode
object
1 property
v3UpdateRelayResponse
object
1 property
v3GetRelayUplinkForwardingRuleResponse
object
1 property
v3RelayUplinkForwardLimits
object
2 properties
NsRelayConfigurationServiceCreateRelayUplinkForwardingRuleBody
object
3 properties
v3CreateRelayUplinkForwardingRuleResponse
object
1 property
v3RelayEndDeviceAlwaysMode
object
v3ListRelayUplinkForwardingRulesResponse
object
1 property
v3RelayResetLimitCounter
string
v3CreateRelayResponse
object
1 property
v3ServingRelaySettings
object
5 properties
googlerpcStatus
object
3 properties
v3RelaySecondChAckOffset
string
v3RelaySmartEnableLevel
string
v3RelaySettings
object
RelaySettings represent the settings of a relay. This is used internally by the Network Server.
2 properties
NsRelayConfigurationServiceUpdateRelayBody
object
3 properties
v3ServedRelaySettings
object
6 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

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

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