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
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Need help?

Contact us
Kin Lane

Chat with Kin

AI assistant · trained on my blog

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.

Documentation Provider Profile APIs.io OpenAPI GitHub

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

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

24 operations 12 paths 22 schemas 5 DELETE9 GET5 POST5 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 2.0
API Version
v3.36
Authentication
API Key
Contact
The Things Industries
License
Apache 2.0
Resource Areas
1

Authentication & Security 1

The Things Network / The Things Stack Pba 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 24

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

Pba 24
GET
/pba/forwarders/policies
List the routing policies that Forwarders configured with Packet Broker Agent as Home Network. Listing routing policies requires administrative access.
Pba_ListForwarderRoutingPolicies 4 params → 200default
GET
/pba/home-networks
List the listed home networks for which routing policies can be configured. Listing home networks requires administrative access.
Pba_ListHomeNetworks 4 params → 200default
GET
/pba/home-networks/gateway-visibilities/default
Get the default gateway visibility. Getting gateway visibilities requires administrative access.
Pba_GetHomeNetworkDefaultGatewayVisibility → 200default
DELETE
/pba/home-networks/gateway-visibilities/default
Deletes the default gateway visibility. Deleting gateway visibilities requires administrative access.
Pba_DeleteHomeNetworkDefaultGatewayVisibility → 200default
POST
/pba/home-networks/gateway-visibilities/default
Set the default gateway visibility. Setting gateway visibilities requires administrative access.
Pba_SetHomeNetworkDefaultGatewayVisibility2 1 param → 200default
PUT
/pba/home-networks/gateway-visibilities/default
Set the default gateway visibility. Setting gateway visibilities requires administrative access.
Pba_SetHomeNetworkDefaultGatewayVisibility 1 param → 200default
GET
/pba/home-networks/policies
List the routing policies that Packet Broker Agent as Forwarder configured with Home Networks. Listing routing policies requires administrative access.
Pba_ListHomeNetworkRoutingPolicies 2 params → 200default
GET
/pba/home-networks/policies/default
Get the default routing policy. Getting routing policies requires administrative access.
Pba_GetHomeNetworkDefaultRoutingPolicy → 200default
DELETE
/pba/home-networks/policies/default
Deletes the default routing policy. Deleting routing policies requires administrative access.
Pba_DeleteHomeNetworkDefaultRoutingPolicy → 200default
POST
/pba/home-networks/policies/default
Set the default routing policy. Setting routing policies requires administrative access.
Pba_SetHomeNetworkDefaultRoutingPolicy2 1 param → 200default
PUT
/pba/home-networks/policies/default
Set the default routing policy. Setting routing policies requires administrative access.
Pba_SetHomeNetworkDefaultRoutingPolicy 1 param → 200default
POST
/pba/home-networks/policies/{home_network_id.net_id}
Set the routing policy for the given Home Network. Setting routing policies requires administrative access.
Pba_SetHomeNetworkRoutingPolicy2 2 params → 200default
PUT
/pba/home-networks/policies/{home_network_id.net_id}
Set the routing policy for the given Home Network. Setting routing policies requires administrative access.
Pba_SetHomeNetworkRoutingPolicy 2 params → 200default
POST
/pba/home-networks/policies/{home_network_id.net_id}/{home_network_id.tenant_id}
Set the routing policy for the given Home Network. Setting routing policies requires administrative access.
Pba_SetHomeNetworkRoutingPolicy4 3 params → 200default
PUT
/pba/home-networks/policies/{home_network_id.net_id}/{home_network_id.tenant_id}
Set the routing policy for the given Home Network. Setting routing policies requires administrative access.
Pba_SetHomeNetworkRoutingPolicy3 3 params → 200default
GET
/pba/home-networks/policies/{net_id}
Get the routing policy for the given Home Network. Getting routing policies requires administrative access.
Pba_GetHomeNetworkRoutingPolicy 2 params → 200default
DELETE
/pba/home-networks/policies/{net_id}
Delete the routing policy for the given Home Network. Deleting routing policies requires administrative access.
Pba_DeleteHomeNetworkRoutingPolicy 2 params → 200default
GET
/pba/home-networks/policies/{net_id}/{tenant_id}
Get the routing policy for the given Home Network. Getting routing policies requires administrative access.
Pba_GetHomeNetworkRoutingPolicy2 2 params → 200default
DELETE
/pba/home-networks/policies/{net_id}/{tenant_id}
Delete the routing policy for the given Home Network. Deleting routing policies requires administrative access.
Pba_DeleteHomeNetworkRoutingPolicy2 2 params → 200default
GET
/pba/info
Get information about the Packet Broker registration. Viewing Packet Packet information requires administrative access.
Pba_GetInfo → 200default
GET
/pba/networks
List all listed networks. Listing networks requires administrative access.
Pba_ListNetworks 5 params → 200default
DELETE
/pba/registration
Deregister from Packet Broker. Packet Broker deregistration requires administrative access. Packet Broker deregistration is only supported for tenants and requires Packet Broker Agent to be configure…
Pba_Deregister → 200default
POST
/pba/registration
Register with Packet Broker. If no registration exists, it will be created. Any existing registration will be updated. Registration settings not in the request message are taken from Packet Broker Ag…
Pba_Register2 1 param → 200default
PUT
/pba/registration
Register with Packet Broker. If no registration exists, it will be created. Any existing registration will be updated. Registration settings not in the request message are taken from Packet Broker Ag…
Pba_Register 1 param → 200default

Schemas 22

The contract defines 22 schemas that model the data the API accepts and returns. The most detailed are v3PacketBrokerGatewayVisibility (8 properties), v3PacketBrokerNetwork (7 properties), v3PacketBrokerRoutingPolicy (5 properties), v3PacketBrokerRoutingPolicyUplink (5 properties). Each schema is shown below with its type and property counts.

v3PacketBrokerDefaultRoutingPolicy
object
3 properties
v3ContactMethod
string
v3ContactType
string
v3PacketBrokerRoutingPolicies
object
1 property
v3PacketBrokerRoutingPolicy
object
5 properties
v3PacketBrokerNetwork
object
7 properties
v3PacketBrokerGatewayVisibility
object
8 properties
v3PacketBrokerNetworks
object
1 property
v3SetPacketBrokerDefaultRoutingPolicyRequest
object
2 properties
v3PacketBrokerNetworkIdentifier
object
2 properties
v3DevAddrPrefix
object
2 properties
v3SetPacketBrokerDefaultGatewayVisibilityRequest
object
1 property
v3PacketBrokerDefaultGatewayVisibility
object
2 properties
PbaSetHomeNetworkRoutingPolicyBody
object
3 properties
v3PacketBrokerInfo
object
4 properties
v3PacketBrokerRoutingPolicyDownlink
object
3 properties
v3PacketBrokerRoutingPolicyUplink
object
5 properties
googlerpcStatus
object
3 properties
v3PacketBrokerDevAddrBlock
object
2 properties
v3ContactInfo
object
5 properties
v3PacketBrokerRegisterRequest
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

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

the-things-network-pba-api-openapi.yml Raw ↑

Other APIs The Things Network / The Things Stack publishes across the network.

The Things Network / The Things Stack AppAs API
AE Profile APIs.io
The Things Network / The Things Stack ApplicationAccess API
AE Profile APIs.io
The Things Network / The Things Stack ApplicationActivationSettingRegistry API
AE Profile APIs.io
The Things Network / The Things Stack ApplicationPackageRegistry API
AE Profile APIs.io
The Things Network / The Things Stack ApplicationPubSubRegistry API
AE Profile APIs.io
The Things Network / The Things Stack ApplicationRegistry API
AE Profile APIs.io
The Things Network / The Things Stack ApplicationUpStorage API
AE Profile APIs.io
The Things Network / The Things Stack ApplicationWebhookRegistry API
AE Profile APIs.io
The Things Network / The Things Stack As API
AE Profile APIs.io
The Things Network / The Things Stack AsEndDeviceBatchRegistry API
AE Profile APIs.io
The Things Network / The Things Stack AsEndDeviceRegistry API
AE Profile APIs.io
The Things Network / The Things Stack ClientAccess API
AE Profile APIs.io
#Pba
← Back to T APIs
API Details
ID
the-things-network:the-things-network-pba-api
Docs
https://www.thethingsindustries.com/docs/api/reference/
Provider
The Things Network / The Things Stack
APIs.io →  GitHub →
Explore more
All APIs Providers APIs.io Network