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

The Things Network / The Things Stack Gs API

The Gs API from The Things Network / The Things Stack — 2 operation(s) for gs.

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

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

2 operations 2 paths 12 schemas 1 GET1 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 2.0
API Version
v3.36
Authentication
API Key
License
Resource Areas
1

Authentication & Security 1

The Things Network / The Things Stack Gs 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 2

Across 2 paths, the API surfaces 2 operations — 1 GET, 1 POST. Each is listed below with its method, path, parameters, and response codes.

Gs 2
POST
/gs/gateways/connection/stats
Get statistics about gateway connections to the Gateway Server of a batch of gateways. - Statistics are not persisted between reconnects. - Gateways that are not connected or are part of a different…
Gs_BatchGetGatewayConnectionStats 1 param → 200default
GET
/gs/gateways/{gateway_id}/connection/stats
Get statistics about the current gateway connection to the Gateway Server. This is not persisted between reconnects.
Gs_GetGatewayConnectionStats 2 params → 200default

Schemas 12

The contract defines 12 schemas that model the data the API accepts and returns. The most detailed are v3GatewayConnectionStats (14 properties), v3GatewayStatus (7 properties), lorawanv3Location (5 properties), GatewayConnectionStatsRoundTripTimes (4 properties). Each schema is shown below with its type and property counts.

v3GatewayRemoteAddress
object
Remote Address of the Gateway, as seen by the Gateway Server.
1 property
googlerpcStatus
object
3 properties
GatewayConnectionStatsRoundTripTimes
object
4 properties
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…
v3GatewayStatus
object
7 properties
v3GatewayConnectionStats
object
Connection stats as monitored by the Gateway Server.
14 properties
v3BatchGetGatewayConnectionStatsRequest
object
2 properties
lorawanv3GatewayIdentifiers
object
2 properties
v3BatchGetGatewayConnectionStatsResponse
object
1 property
lorawanv3Location
object
5 properties
GatewayConnectionStatsSubBand
object
4 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

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

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

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

The Things Network / The Things Stack AppAs API
The Things Network / The Things Stack ApplicationAccess API
The Things Network / The Things Stack ApplicationActivationSettingRegistry API
The Things Network / The Things Stack ApplicationPackageRegistry API
The Things Network / The Things Stack ApplicationPubSubRegistry API
The Things Network / The Things Stack ApplicationRegistry API
The Things Network / The Things Stack ApplicationUpStorage API
The Things Network / The Things Stack ApplicationWebhookRegistry API
The Things Network / The Things Stack As API
The Things Network / The Things Stack AsEndDeviceBatchRegistry API
The Things Network / The Things Stack AsEndDeviceRegistry API
The Things Network / The Things Stack ClientAccess API