The Things Network / The Things Stack

The Things Network / The Things Stack Pba API

The Pba API from The Things Network / The Things Stack — 12 operation(s) for pba.

GitHub OpenAPI

Operations 24

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

GET /pba/forwarders/policies List routing policies forwarders set toward my network · List the routing policies that Forwarders configured with Packet Broker Agent… #
Ask an LLM
“Which forwarders on Packet Broker have configured routing policies toward my network as Home Network?”
“Can I see the policies that other networks' forwarders apply to traffic they send to us?”
Tell an agent
List the routing policies forwarders have configured for my network as Home Network.
Show forwarder routing policies aimed at home NetID {net_id}, page {page}.
GET /pba/home-networks List home networks available for routing policies · List the listed home networks for which routing policies can be configured. #
Ask an LLM
“What home networks are listed on Packet Broker that I can configure routing policies for?”
“Can I find a listed home network by part of its name?”
Tell an agent
List the home networks I can set routing policies for.
Find listed home networks whose name contains {name}.
GET /pba/home-networks/gateway-visibilities/default Get the default gateway visibility · Get the default gateway visibility. #
Ask an LLM
“What gateway information do we share with home networks by default through Packet Broker?”
“How can I check the current default gateway visibility setting?”
Tell an agent
Show the default gateway visibility for Packet Broker home networks.
Get the gateway visibility that applies to home networks by default.
DELETE /pba/home-networks/gateway-visibilities/default Remove the default gateway visibility · Deletes the default gateway visibility. #
Ask an LLM
“How do I clear the default gateway visibility so no default is set?”
“Can I delete the default gateway visibility setting entirely?”
Tell an agent destructive · confirm first
Delete the default gateway visibility.
Remove the default gateway visibility setting from Packet Broker Agent.
POST /pba/home-networks/gateway-visibilities/default Set the default gateway visibility (POST) · Set the default gateway visibility. #
Ask an LLM
“Is there a POST variant for setting the default gateway visibility?”
“Can I post a default gateway visibility instead of using PUT?”
Tell an agent
POST the default gateway visibility {visibility} to Packet Broker Agent.
Use the POST endpoint to set default gateway visibility to {visibility}.
PUT /pba/home-networks/gateway-visibilities/default Set the default gateway visibility (PUT) · Set the default gateway visibility. #
Ask an LLM
“How do I change which gateway details home networks see by default, using PUT?”
“Can I replace the default gateway visibility with a PUT request?”
Tell an agent
Set the default gateway visibility to {visibility} using PUT.
PUT a new default gateway visibility of {visibility} for all home networks.
GET /pba/home-networks/policies List my routing policies toward home networks · List the routing policies that Packet Broker Agent as Forwarder configured with… #
Ask an LLM
“Which routing policies has our Packet Broker Agent, as Forwarder, set for home networks?”
“Can I page through the per-home-network policies we configured as a forwarder?”
Tell an agent
List the routing policies we configured as Forwarder for home networks.
Show page {page} of our forwarder routing policies, {limit} at a time.
GET /pba/home-networks/policies/default Get the default routing policy · Get the default routing policy. #
Ask an LLM
“What uplink and downlink routing applies by default to home networks without their own policy?”
“How can I see the default Packet Broker routing policy?”
Tell an agent
Show the default routing policy for home networks.
Get the default Packet Broker routing policy.
DELETE /pba/home-networks/policies/default Delete the default routing policy · Deletes the default routing policy. #
Ask an LLM
“How do I remove the default routing policy so home networks have no default?”
“What happens if I delete the default Packet Broker routing policy?”
Tell an agent destructive · confirm first
Delete the default routing policy.
Remove the default Packet Broker routing policy for home networks.
POST /pba/home-networks/policies/default Set the default routing policy (POST) · Set the default routing policy. #
Ask an LLM
“Is there a POST endpoint for setting the default routing policy?”
“Can I post new default uplink and downlink routing rules?”
Tell an agent
POST a default routing policy with uplink {uplink} and downlink {downlink}.
Use POST to set the default routing policy downlink to {downlink}.
PUT /pba/home-networks/policies/default Set the default routing policy (PUT) · Set the default routing policy. #
Ask an LLM
“How do I set the default uplink and downlink routing policy with PUT?”
“Can I replace the default routing policy's downlink rules via a PUT request?”
Tell an agent
PUT a default routing policy with uplink {uplink} and downlink {downlink}.
Update the default routing policy uplink settings to {uplink} using PUT.
POST /pba/home-networks/policies/{home_network_id.net_id} Set a home network's routing policy (POST) · Set the routing policy for the given Home Network. #
Ask an LLM
“Is there a POST variant for setting a NetID-specific routing policy?”
“Can I post routing rules for a home network identified only by NetID?”
Tell an agent
POST a routing policy for home NetID {net_id} with uplink {uplink} and downlink {downlink}.
Use POST to set home network {net_id}'s uplink rules to {uplink}.
PUT /pba/home-networks/policies/{home_network_id.net_id} Set a home network's routing policy (PUT) · Set the routing policy for the given Home Network. #
Ask an LLM
“How do I set a routing policy for one specific home network by its NetID using PUT?”
“Can I give a single NetID its own uplink routing rules instead of the default?”
Tell an agent
PUT a routing policy for home NetID {net_id} with uplink {uplink}.
Set the downlink policy for home network {net_id} to {downlink} via PUT.
POST /pba/home-networks/policies/{home_network_id.net_id}/{home_network_id.tenant_id} Set a tenant home network's routing policy (POST) · Set the routing policy for the given Home Network. #
Ask an LLM
“Is there a POST endpoint for a NetID-plus-tenant routing policy?”
“Can I post uplink and downlink routing for one tenant of a home NetID?”
Tell an agent
POST a routing policy for NetID {net_id} tenant {tenant_id} with downlink {downlink}.
Use POST to set uplink {uplink} for tenant {tenant_id} of home NetID {net_id}.
PUT /pba/home-networks/policies/{home_network_id.net_id}/{home_network_id.tenant_id} Set a tenant home network's routing policy (PUT) · Set the routing policy for the given Home Network. #
Ask an LLM
“How do I set a routing policy for a specific tenant inside a NetID using PUT?”
“Can routing policies target a tenant that leases DevAddr blocks from a NetID?”
Tell an agent
PUT a routing policy for tenant {tenant_id} of NetID {net_id} with uplink {uplink}.
Set the downlink rules for tenant {tenant_id} on NetID {net_id} to {downlink} via PUT.
GET /pba/home-networks/policies/{net_id} Get a home network's routing policy by NetID · Get the routing policy for the given Home Network. #
Ask an LLM
“What routing policy do we apply to a given home NetID?”
“Can I look up a home network's policy by NetID and optionally filter by tenant as a query parameter?”
Tell an agent
Show the routing policy for home NetID {net_id}.
Get the routing policy for NetID {net_id} with tenant {tenant_id} passed as a query filter.
DELETE /pba/home-networks/policies/{net_id} Delete a home network's routing policy by NetID · Delete the routing policy for the given Home Network. #
Ask an LLM
“How do I remove the custom routing policy for a home NetID so it falls back to the default?”
“Can I delete a NetID's routing policy while passing the tenant as a query parameter?”
Tell an agent destructive · confirm first
Delete the routing policy for home NetID {net_id}.
Remove the routing policy for NetID {net_id}, tenant {tenant_id} given as a query value.
GET /pba/home-networks/policies/{net_id}/{tenant_id} Get a tenant home network's routing policy · Get the routing policy for the given Home Network. #
Ask an LLM
“Which routing policy applies to a specific tenant within a home NetID, addressed in the path?”
“How do I read the policy for a NetID and tenant pair?”
Tell an agent
Show the routing policy for NetID {net_id} and tenant {tenant_id} using the tenant path.
Get the policy we apply to tenant {tenant_id} under home NetID {net_id}.
DELETE /pba/home-networks/policies/{net_id}/{tenant_id} Delete a tenant home network's routing policy · Delete the routing policy for the given Home Network. #
Ask an LLM
“How do I delete the routing policy for one tenant of a home NetID via the tenant path?”
“Can I remove a tenant-specific policy without touching the rest of the NetID?”
Tell an agent destructive · confirm first
Delete the routing policy for tenant {tenant_id} of NetID {net_id} using the tenant path.
Remove the NetID {net_id} tenant {tenant_id} routing policy.
GET /pba/info Get Packet Broker registration info · Get information about the Packet Broker registration. #
Ask an LLM
“What does our Packet Broker registration look like right now?”
“Is our network registered with Packet Broker, and with what settings?”
Tell an agent
Show our Packet Broker registration information.
Get the Packet Broker Agent registration details.
GET /pba/networks List networks listed on Packet Broker · List all listed networks. Listing networks requires administrative access #
Ask an LLM
“Which networks are listed on Packet Broker?”
“Can I list only networks that have a routing policy configured?”
Tell an agent
List all networks listed on Packet Broker.
List listed networks where routing policy presence is {with_routing_policy}.
DELETE /pba/registration Deregister from Packet Broker · Deregister from Packet Broker. #
Ask an LLM
“How do I remove our tenant's registration from Packet Broker?”
“Who is allowed to deregister from Packet Broker?”
Tell an agent destructive · confirm first
Deregister our network from Packet Broker.
Delete our Packet Broker registration.
POST /pba/registration Register with Packet Broker (POST) · Register with Packet Broker. #
Ask an LLM
“Is there a POST endpoint for registering our network with Packet Broker?”
“Can I post a registration that makes our network unlisted?”
Tell an agent
POST a Packet Broker registration with listed set to {listed}.
Use the POST registration endpoint to register with Packet Broker.
PUT /pba/registration Register with Packet Broker (PUT) · Register with Packet Broker. #
Ask an LLM
“How do I register or update our network's Packet Broker registration using PUT?”
“Can I choose whether our network is listed publicly when registering?”
Tell an agent
Register with Packet Broker via PUT and set listed to {listed}.
Create or update our Packet Broker registration using PUT.

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-pba-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-pba-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-pba-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Things Stack — Packet Broker Agent Pba API
  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 (34 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/the-things-network/refs/heads/main/openapi/the-things-network-pba-api-openapi.yml