The Things Network / The Things Stack GatewayAccess 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 GatewayAccess. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and 9 JSON Schemas.
This API exposes
12 operations
across 9 paths,
and defines 15 schemas.
It is described by OpenAPI 2.0, at version v3.36.
12 operations9 paths15 schemas3 DELETE6 GET1 POST2 PUT
Metadata
The identity and technical contract details declared by the specification.
The Things Network / The Things Stack GatewayAccess 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 12
Across 9 paths, the API surfaces 12 operations — 3 DELETE, 6 GET, 1 POST, 2 PUT. Each is listed below with its method, path, parameters, and response codes.
Update the rights of an API key of the gateway. This method can also be used to delete the API key, by giving it no rights. The caller is required to have all assigned or/and removed rights.
Set the rights of a collaborator (member) on the gateway. This method can also be used to delete the collaborator, by giving them no rights. The caller is required to have all assigned or/and removed…
The contract defines 15 schemas that model the data the API accepts and returns. The most detailed are v3APIKey (7 properties), v3GatewayAccessCreateAPIKeyBody (4 properties), googlerpcStatus (3 properties), v3GatewayAccessUpdateAPIKeyBody (3 properties). Each schema is shown below with its type and property counts.
v3Rights
object
1 property
v3APIKey
object
7 properties
v3Collaborator
object
2 properties
googlerpcStatus
object
3 properties
v3Right
string
Right is the enum that defines all the different rights to do something in the network. - RIGHTUSERINFO: The right to view user information. - RIGHTUSERSETTING…
v3GatewayAccessCreateAPIKeyBody
object
4 properties
v3GatewayAccessUpdateAPIKeyBody
object
3 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
v3UserIdentifiers
object
2 properties
v3APIKeys
object
1 property
v3Collaborators
object
1 property
v3GatewayAccessSetCollaboratorBody
object
2 properties
v3GetCollaboratorResponse
object
2 properties
v3OrganizationOrUserIdentifiers
object
OrganizationOrUserIdentifiers contains either organization or user identifiers.
2 properties
v3OrganizationIdentifiers
object
1 property
Specification
The full machine-readable OpenAPI contract behind this narrative.
