The Things Network / The Things Stack

The Things Network / The Things Stack NsRelayConfigurationService API

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

GitHub OpenAPI
Business capability
Network Configuration Management BC-2600.20

Operations 9

Each operation below carries the questions people ask an LLM about it and the instructions they give an agent to run it. Generated by API Evangelist overlay

POST /ns/applications/{end_device_ids.application_ids.application_id}/relays Configure an end device as a LoRaWAN relay · Create a relay #
Ask an LLM
“How do I turn one of my end devices into a LoRaWAN relay on the Network Server?”
“Can I set relay settings for a device when I first create the relay?”
Tell an agent
Create a relay for device {end_device_ids} in application {application_id}.
Set up relay {end_device_ids} in app {application_id} with settings {settings}.
GET /ns/applications/{end_device_ids.application_ids.application_id}/relays/{end_device_ids.device_id} Get a device's relay configuration · Get a relay #
Ask an LLM
“What relay settings are configured on a particular end device?”
“Can I read back a relay's configuration by device ID?”
Tell an agent
Show the relay configuration of device {device_id} in application {application_id}.
Get only {field_mask} of relay {device_id} in app {application_id}.
DELETE /ns/applications/{end_device_ids.application_ids.application_id}/relays/{end_device_ids.device_id} Remove relay configuration from a device · Delete a relay #
Ask an LLM
“How do I stop an end device from acting as a relay?”
“Does deleting a relay remove the end device itself or only its relay role?”
Tell an agent destructive · confirm first
Delete the relay on device {device_id} in application {application_id}.
Turn off relaying for {device_id} in app {application_id}.
PUT /ns/applications/{end_device_ids.application_ids.application_id}/relays/{end_device_ids.device_id} Update a relay's settings · Update a relay #
Ask an LLM
“How do I change the settings of an existing relay device?”
“Can I update selected relay fields with a field mask?”
Tell an agent
Update the relay settings of device {device_id} in application {application_id}.
Change relay {device_id} in app {application_id} to settings {settings}.
GET /ns/applications/{end_device_ids.application_ids.application_id}/relays/{end_device_ids.device_id}/uplink-forwarding-rules List a relay's uplink forwarding rules · List uplink forwarding rules #
Ask an LLM
“Which uplink forwarding rules are set on my relay?”
“Can I see every rule controlling what a relay forwards upstream?”
Tell an agent
List the uplink forwarding rules of relay {device_id} in application {application_id}.
Show all forwarding rules on relay {device_id} of app {application_id}.
POST /ns/applications/{end_device_ids.application_ids.application_id}/relays/{end_device_ids.device_id}/uplink-forwarding-rules Add an uplink forwarding rule to a relay · Create an uplink forwarding rule #
Ask an LLM
“How do I add a rule telling a relay which uplinks to forward?”
“Can I place a new forwarding rule at a specific index on the relay?”
Tell an agent
Add forwarding rule {rule} at index {index} on relay {device_id} in application {application_id}.
Create a new uplink forwarding rule for relay {device_id} in app {application_id}.
GET /ns/applications/{end_device_ids.application_ids.application_id}/relays/{end_device_ids.device_id}/uplink-forwarding-rules/{index} Get one relay uplink forwarding rule · Get an uplink forwarding rule #
Ask an LLM
“What does the forwarding rule at a given index on my relay contain?”
“Can I read a single relay rule by its position?”
Tell an agent
Show forwarding rule {index} of relay {device_id} in application {application_id}.
Get rule number {index} on relay {device_id} of app {application_id}.
DELETE /ns/applications/{end_device_ids.application_ids.application_id}/relays/{end_device_ids.device_id}/uplink-forwarding-rules/{index} Delete a relay uplink forwarding rule · Delete an uplink forwarding rule #
Ask an LLM
“How do I remove one forwarding rule from a relay?”
“Will deleting a relay rule leave the relay itself configured?”
Tell an agent destructive · confirm first
Delete forwarding rule {index} from relay {device_id} in application {application_id}.
Drop rule number {index} on relay {device_id} of app {application_id}.
PUT /ns/applications/{end_device_ids.application_ids.application_id}/relays/{end_device_ids.device_id}/uplink-forwarding-rules/{index} Update a relay uplink forwarding rule · Update an uplink forwarding rule #
Ask an LLM
“How do I edit an existing uplink forwarding rule on a relay?”
“Can I change one field of a relay rule without replacing the others?”
Tell an agent
Update forwarding rule {index} on relay {device_id} in application {application_id} to {rule}.
Edit rule number {index} of relay {device_id} in app {application_id}.

Documentation

📖
Documentation
https://www.thethingsindustries.com/docs/api/reference/
📖
Documentation
https://www.thethingsindustries.com/docs/concepts/architecture/
📖
Documentation
https://www.thethingsindustries.com/docs/devices/
📖
Documentation
https://www.thethingsindustries.com/docs/integrations/
📖
Documentation
https://www.thethingsindustries.com/docs/concepts/packet-broker/
📖
Documentation
https://www.thethingsindustries.com/docs/concepts/features/events/

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/the-things-network/refs/heads/main/openapi/the-things-network-nsrelayconfigurationservice-api-openapi.yml

Schemas & Data

📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/the-things-network/refs/heads/main/json-schema/the-things-stack-user-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/the-things-network/refs/heads/main/json-schema/the-things-stack-organization-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/the-things-network/refs/heads/main/json-schema/the-things-stack-api-key-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/the-things-network/refs/heads/main/json-schema/the-things-stack-application-up-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/the-things-network/refs/heads/main/json-schema/the-things-stack-gateway-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/the-things-network/refs/heads/main/json-schema/the-things-stack-gateway-status-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/the-things-network/refs/heads/main/json-schema/the-things-stack-end-device-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/the-things-network/refs/heads/main/json-schema/the-things-stack-application-webhook-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/the-things-network/refs/heads/main/json-schema/the-things-stack-application-pubsub-schema.json

Other Resources

🔗
Examples
https://raw.githubusercontent.com/api-evangelist/the-things-network/refs/heads/main/examples/the-things-stack-uplink-message-example.json
🔗
Examples
https://raw.githubusercontent.com/api-evangelist/the-things-network/refs/heads/main/examples/the-things-stack-gateway-create-example.json
🔗
Examples
https://raw.githubusercontent.com/api-evangelist/the-things-network/refs/heads/main/examples/the-things-stack-end-device-create-example.json
🔗
Examples
https://raw.githubusercontent.com/api-evangelist/the-things-network/refs/heads/main/examples/the-things-stack-webhook-create-example.json

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/the-things-network:the-things-network-nsrelayconfigurationservice-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

the-things-network-nsrelayconfigurationservice-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Things Stack — Network Server Ns Relay Configuration…
  version: v3.36
  description: The Things Stack is an open-source LoRaWAN Network Server implementation. This OpenAPI was derived from the upstream gRPC-Gateway generated api.swagger.json published by TheThingsNetwork/lorawan-stack v3.36.
  license:
    name: Apache 2.0
    url: https://www.apache.org/licenses/LICENSE-2.0
  contact:
    name: The Things Industries
    url: https://www.thethingsindustries.com
servers:
- url: https://eu1.cloud.thethings.industries/api/v3
security:
- ApiKeyAuth: []
tags:


# --- truncated at 32 KB (32 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/the-things-network/refs/heads/main/openapi/the-things-network-nsrelayconfigurationservice-api-openapi.yml