The Things Network / The Things Stack GatewayRegistry 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 GatewayRegistry. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and 9 JSON Schemas.
This API exposes
11 operations
across 9 paths,
and defines 24 schemas.
It is described by OpenAPI 2.0, at version v3.36.
11 operations9 paths24 schemas2 DELETE4 GET4 POST1 PUT
Metadata
The identity and technical contract details declared by the specification.
The Things Network / The Things Stack GatewayRegistry 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 11
Across 9 paths, the API surfaces 11 operations — 2 DELETE, 4 GET, 4 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.
GatewayRegistry 11
GET
/gateways
List gateways where the given user or organization is a direct collaborator. If no user or organization is given, this returns the gateways the caller has access to. Similar to Get, this selects the…
GatewayRegistry_List8 params→ 200default
POST
/gateways/filter
List gateways where the given user or organization is a direct collaborator. If no user or organization is given, this returns the gateways the caller has access to. Similar to Get, this selects the…
GatewayRegistry_List41 param→ 200default
PUT
/gateways/{gateway.ids.gateway_id}
Update the gateway, changing the fields specified by the field mask to the provided values.
GatewayRegistry_Update2 params→ 200default
GET
/gateways/{gateway_ids.gateway_id}
Get the gateway with the given identifiers, selecting the fields specified in the field mask. More or less fields may be returned, depending on the rights of the caller.
GatewayRegistry_Get3 params→ 200default
DELETE
/gateways/{gateway_id}
Delete the gateway. This may not release the gateway ID for reuse, but it does release the EUI.
GatewayRegistry_Delete2 params→ 200default
DELETE
/gateways/{gateway_id}/purge
Purge the gateway. This will release both gateway ID and EUI for reuse. The gateway owner is responsible for clearing data from any (external) integrations that may store and expose data by gateway I…
GatewayRegistry_Purge2 params→ 200default
POST
/gateways/{gateway_id}/restore
Restore a recently deleted gateway. This does not restore the EUI, as that was released when deleting the gateway.
List gateways where the given user or organization is a direct collaborator. If no user or organization is given, this returns the gateways the caller has access to. Similar to Get, this selects the…
Create a new gateway. This also sets the given organization or user as first collaborator with all possible rights.
GatewayRegistry_Create22 params→ 200default
GET
/users/{collaborator.user_ids.user_id}/gateways
List gateways where the given user or organization is a direct collaborator. If no user or organization is given, this returns the gateways the caller has access to. Similar to Get, this selects the…
GatewayRegistry_List28 params→ 200default
POST
/users/{collaborator.user_ids.user_id}/gateways
Create a new gateway. This also sets the given organization or user as first collaborator with all possible rights.
GatewayRegistry_Create2 params→ 200default
Schemas 24
The contract defines 24 schemas that model the data the API accepts and returns. The most detailed are v3Gateway (31 properties), v3ListGatewaysRequest (7 properties), v3ContactInfo (5 properties), v3GatewayVersionIdentifiers (5 properties). Each schema is shown below with its type and property counts.
v3GatewayRegistryCreateBody
object
2 properties
v3ContactMethod
string
v3LocationSource
string
- SOURCEUNKNOWN: The source of the location is not known or not set. - SOURCEGPS: The location is determined by GPS. - SOURCEREGISTRY: The location is set in a…
v3ContactType
string
lorawanv3GatewayIdentifiers
object
2 properties
v3GatewayAntenna
object
GatewayAntenna is the message that defines a gateway antenna.
4 properties
v3ListGatewaysRequest
object
7 properties
v3GatewayClaimAuthenticationCode
object
Authentication code for claiming gateways.
3 properties
lorawanv3Location
object
5 properties
GatewayLRFHSS
object
LR-FHSS gateway capabilities.
1 property
v3OrganizationOrUserIdentifiers
object
OrganizationOrUserIdentifiers contains either organization or user identifiers.
2 properties
v3ListGatewaysRequestFilter
object
Filter gateways by fields.
1 property
v3Secret
object
Secret contains a secret value. It also contains the ID of the Encryption key used to encrypt it.
2 properties
v3DownlinkPathConstraint
string
- DOWNLINKPATHCONSTRAINTNONE: Indicates that the gateway can be selected for downlink without constraints by the Network Server. - DOWNLINKPATHCONSTRAINTPREFER…
v3GatewayRegistryUpdateBody
object
2 properties
v3OrganizationIdentifiers
object
1 property
v3Gateway
object
Gateway is the message that defines a gateway on the network.
31 properties
googlerpcStatus
object
3 properties
v3GatewayAntennaPlacement
string
v3Gateways
object
1 property
v3UserIdentifiers
object
2 properties
v3ContactInfo
object
5 properties
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
v3GatewayVersionIdentifiers
object
Identifies an end device model with version information.
5 properties
Specification
The full machine-readable OpenAPI contract behind this narrative.
