Gateway Server APIs

GET /api/v3/gs/gateways/{gateway_id}/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 cluster are ignored.
• The client should ensure that the requested gateways are in the requested cluster.
• The client should have the right to get the gateway connection stats on all requested gateways.

POST /api/v3/gs/gateways/connection/stats

/api/v3

GET /api/v3/gcs/gateways/configuration/{gateway_ids.gateway_id}/{format}/{filename}

GET /api/v3/gcs/gateways/configuration/{gateway_ids.gateway_id}/{format}/{type}/{filename}

GET /api/v3/gs/gateways/{gateway_id}/mqtt-connection-info

GET /api/v3/gs/gateways/{gateway_id}/mqttv2-connection-info

max_len: 36

pattern: ^[a-z0-9](?:[-]?[a-z0-9]){2,}$

max_items: 100

min_items: 1

The names of the gateway stats fields that should be returned. This mask will be applied on each entry returned.

The map key is the gateway identifier.

defined_only

Frequencies to be broadcasted, in hecto-Hz. These values are broadcasted as 24 bits unsigned integers. This field should not contain default values.

ChMasks controlling the channels to be used. Length of this field must be equal to the amount of uplink channels defined by the selected frequency plan.

Frequency (Hz).

Frequency (Hz).

Bandwidth (Hz).

Frequency (Hz).

Received signal strength (dBm).

Received signal strength offset (dBm).

defined_only

defined_only

OptNeg is set if Network Server implements LoRaWAN 1.1 or greater.

max_len: 100

max_len: 2048

max_len: 36

pattern: ^[a-z0-9](?:[-]?[a-z0-9]){2,}$

required

The LoRaWAN DevEUI.

ignore_empty

len: 8

The LoRaWAN JoinEUI (AppEUI until LoRaWAN 1.0.3 end devices).

ignore_empty

len: 8

The LoRaWAN DevAddr.

ignore_empty

len: 4

ignore_empty

len: 4

required

lte: 65535

max_len: 15

Only on uplink.

Only on downlink.

Only on uplink.

Bit rate (bps).

required

max_len: 36

pattern: ^[a-z0-9](?:[-]?[a-z0-9]){2,}$

Secondary identifier, which can only be used in specific requests.

ignore_empty

len: 8

required

max_len: 36

pattern: ^[a-z0-9](?:[-]?[a-z0-9]){2,}$|^$

max_len: 36

pattern: ^[a-z0-9](?:[-]?[a-z0-9]){2,}$|^$

max_len: 36

pattern: ^[a-z0-9](?:[-._]?[a-z0-9]){2,}$|^$

Protocol used to connect (for example, udp, mqtt, grpc)

Statistics for each sub band.

Gateway Remote Address.

Duty-cycle limit of the sub-band as a fraction of time.

Utilization rate of the available duty-cycle. This value should not exceed downlink_utilization_limit.

DownlinkMessage for the gateway.

Current time of the gateway

Boot time of the gateway

• can be left out to save bandwidth; old value will be kept

Versions of gateway subsystems

• each field can be left out to save bandwidth; old value will be kept
• map keys are written in snake_case
• for example: firmware: “2.0.4” forwarder: “v2-3.3.1” fpga: “48” dsp: “27” hal: “v2-3.5.0”

max_pairs: 10

max_len (key): 36

pattern (key): ^[a-z0-9](?:[_-]?[a-z0-9]){2,}$

max_len (value): 128

Location of each gateway’s antenna

• if left out, server uses registry-set location as fallback

max_items: 8

IP addresses of this gateway. Repeated addresses can be used to communicate addresses of multiple interfaces (LAN, Public IP, …).

max_items: 10

ip

Metrics

• can be used for forwarding gateway metrics such as temperatures or performance metrics
• map keys are written in snake_case

max_pairs: 32

max_len (key): 36

pattern (key): ^[a-z0-9](?:[_-]?[a-z0-9]){2,}$

Advanced metadata fields

• can be used for advanced information or experimental features that are not yet formally defined in the API
• field names are written in snake_case

IPv4 or IPv6 address.

Uplink messages received by the gateway.

Gateway status produced by the gateway.

A Tx acknowledgment or error.

ignore_empty

len: 3

ignore_empty

len: 3

ignore_empty

len: 4

required

defined_only

ignore_empty

len: 8

ignore_empty

len: 8

ignore_empty

len: 2

The North–South position (degrees; -90 to +90), where 0 is the equator, North pole is positive, South pole is negative.

gte: -90

lte: 90

The East-West position (degrees; -180 to +180), where 0 is the Prime Meridian (Greenwich), East is positive , West is negative.

gte: -180

lte: 180

The altitude (meters), where 0 is the mean sea level.

The accuracy of the location (meters).

Source of the location information.

defined_only

Bandwidth (Hz).

Operating Channel Width (Hz).

required

lte: 255

Full 32-bit FCnt value. Used internally by Network Server.

required

max_len: 4

defined_only

defined_only

The public listen address of the frontend.

pattern: ^(?:(?:[a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\-]*[a-zA-Z0-9])\.)*(?:[A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9\-]*[A-Za-z0-9])(?::[0-9]{1,5})?$|^$

The public listen address of the TLS frontend.

pattern: ^(?:(?:[a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\-]*[a-zA-Z0-9])\.)*(?:[A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9\-]*[A-Za-z0-9])(?::[0-9]{1,5})?$|^$

The username to be used for authentication.

Message identifier generated by Packet Broker Router.

LoRa Alliance NetID of the Packet Broker Forwarder Member.

ignore_empty

len: 3

Tenant ID managed by the Packet Broker Forwarder Member.

Forwarder Cluster ID of the Packet Broker Forwarder.

Forwarder gateway EUI.

ignore_empty

len: 8

Forwarder gateway ID.

LoRa Alliance NetID of the Packet Broker Home Network Member.

ignore_empty

len: 3

Tenant ID managed by the Packet Broker Home Network Member. This value is empty if it cannot be determined by the Packet Broker Router.

Home Network Cluster ID of the Packet Broker Home Network.

Hops that the message passed. Each Packet Broker Router service appends an entry.

Time when the service received the message.

Sender of the message, typically the authorized client identifier.

Sender IP address or host name.

Receiver of the message.

Receiver agent.

defined_only

ignore_empty

len: 3

ignore_empty

len: 8

ignore_empty

len: 8

Contains RJCount0 or RJCount1 depending on rejoin_type.

required

Timestamp at the end of the transmission, provided by the gateway. The accuracy is undefined.

Gateway concentrator timestamp when the Rx finished (microseconds).

Gateway’s internal fine timestamp when the Rx finished (nanoseconds).

Encrypted gateway’s internal fine timestamp when the Rx finished (nanoseconds).

Received signal strength indicator (dBm). This value equals channel_rssi.

Received signal strength indicator of the signal (dBm).

Received signal strength indicator of the channel (dBm).

Standard deviation of the RSSI during preamble.

Signal-to-noise ratio (dB).

Frequency offset (Hz).

Antenna location; injected by the Gateway Server.

Gateway downlink path constraint; injected by the Gateway Server.

defined_only

Uplink token to be included in the Tx request in class A downlink; injected by gateway, Gateway Server or fNS.

Index of the gateway channel that received the message.

lte: 255

Hopping width; a number describing the number of steps of the LR-FHSS grid.

Frequency drift in Hz between start and end of an LR-FHSS packet (signed).

Timestamp at the end of the transmission, provided by the gateway. Guaranteed to be based on a GPS PPS signal, with an accuracy of 1 millisecond.

Timestamp at which the Gateway Server has received the message.

Advanced metadata fields

• can be used for advanced information or experimental features that are not yet formally defined in the API
• field names are written in snake_case

required

Server time when a component received the message. The Gateway Server and Network Server set this value to their local server time of reception.

max_len: 100

Index of the device channel that received the message. Set by Network Server.

lte: 255

Consumed airtime for the transmission of the uplink message. Calculated by Network Server using the RawPayload size and the transmission settings.

Cyclic Redundancy Check (CRC) status of demodulating the frame. If unset, the modulation does not support CRC or the gateway did not provide a CRC status. If set to false, this message should not be processed.

Correlation IDs for the downlink message. Set automatically by the UDP and LBS frontends. For gRPC and the MQTT v3 frontends, the correlation IDs must match the ones of the downlink message the Tx acknowledgment message refers to.

max_len: 100

defined_only

The acknowledged downlink message. Set by the Gateway Server.

Index of the antenna on which the uplink was received and/or downlink must be sent.

Transmission power (dBm). Only on downlink.

Invert LoRa polarization; false for LoRaWAN uplink, true for downlink.

Downlink paths used to select a gateway for downlink. In class A, the downlink paths are required to only contain uplink tokens. In class B and C, the downlink paths may contain uplink tokens and fixed gateways antenna identifiers.

Rx1 delay (Rx2 delay is Rx1 delay + 1 second).

defined_only

LoRaWAN data rate for Rx1.

Frequency (Hz) for Rx1.

LoRaWAN data rate for Rx2.

Frequency (Hz) for Rx2.

Priority for scheduling. Requests with a higher priority are allocated more channel time than messages with a lower priority, in duty-cycle limited regions. A priority of HIGH or higher sets the HiPriorityFlag in the DLMetadata Object.

defined_only

Time when the downlink message should be transmitted. This value is only valid for class C downlink; class A downlink uses uplink tokens and class B downlink is scheduled on ping slots. This requires the gateway to have GPS time sychronization. If the absolute time is not set, the first available time will be used that does not conflict or violate regional limitations.

Frequency plan ID from which the frequencies in this message are retrieved.

max_len: 64

Advanced metadata fields

• can be used for advanced information or experimental features that are not yet formally defined in the API
• field names are written in snake_case

Downlink paths used to select a gateway for downlink. In class A, the downlink paths are required to only contain uplink tokens. In class B and C, the downlink paths may contain uplink tokens and fixed gateways antenna identifiers.

Rx1 delay (Rx2 delay is Rx1 delay + 1 second).

defined_only

LoRaWAN data rate for Rx1.

Frequency (Hz) for Rx1.

LoRaWAN data rate for Rx2.

Frequency (Hz) for Rx2.

Priority for scheduling. Requests with a higher priority are allocated more channel time than messages with a lower priority, in duty-cycle limited regions. A priority of HIGH or higher sets the HiPriorityFlag in the DLMetadata Object.

defined_only

Time when the downlink message should be transmitted. This value is only valid for class C downlink; class A downlink uses uplink tokens and class B downlink is scheduled on ping slots. This requires the gateway to have GPS time sychronization. If the absolute time is not set, the first available time will be used that does not conflict or violate regional limitations.

Frequency plan ID from which the frequencies in this message are retrieved.

max_len: 64

Advanced metadata fields

• can be used for advanced information or experimental features that are not yet formally defined in the API
• field names are written in snake_case

Data rate.

required

Frequency (Hz).

gte: 100000

Send a CRC in the packet; only on uplink; on downlink, CRC should not be enabled.

Timestamp of the gateway concentrator when the uplink message was received, or when the downlink message should be transmitted (microseconds). On downlink, set timestamp to 0 and time to null to use immediate scheduling.

Time of the gateway when the uplink message was received, or when the downlink message should be transmitted. For downlink, this requires the gateway to have GPS time synchronization.

Transmission settings for downlink.

Concentrator timestamp for the downlink as calculated by the Gateway Server scheduler. This value takes into account necessary offsets such as the RTT (Round Trip Time) and TOA (Time Of Arrival). This field is set and used only by the Gateway Server.