Gateway Glossary

Prev Next

UI Field

API Name

Description

Category

Name

name

Custom name given to the gateway.

common

Gateway ID

gatewayId

Unique platform identifier for internal referencing.

common

Gateway Group ID

gatewayGroupId

ID linking the gateway to a specific gateway group.

common

Customer ID

customerId

Identifies which customer owns the gateway.

common

Deleted

deleted

Indicates whether the gateway has been marked as deleted.

common

Deleted Timestamp

deletedTimestamp

When the gateway was deleted.

common

Deleted Reason

deletedReason

Why the gateway was deleted.

common

Serial Number

serialNumber

Hardware serial number.

common

MAC Address

mac

Hardware MAC address of the gateway.

common

Gateway IMEI

imei

Device modem’s International Mobile Equipment Identity.

common

Gateway ICCID

iccid

SIM card identifier (Integrated Circuit Card ID).

common

Gateway IMSI

imsi

Mobile subscriber identifier tied to the SIM.

common

Description

description

Optional descriptive text for the gateway.

common

Gateway Type ID

gatewayTypeId

Defines the type/category of gateway.

common

Installed

installed

Indicates whether the gateway has been flagged as installed.

common

Installed Timestamp

installedTimestamp

Time of initial installation.

common

Installation Changed Timestamp

installationChangeTimestamp

Time of the last installation status change.

common

Installer

installer

Person or entity responsible for physical installation.

common

Latitude / Longitude

location.latitude, location.longitude

GPS coordinates for mapping.

location

Street / Street No / City / Country / Postal Code

location.address.*

Full address for on-site identification.

location

Location Type

locationType, locationTypeDescription

Defines the classification of the location (e.g., ACCUMULATOR).

common

Tags

tags.*

Custom metadata tags linked to the gateway.

common

Contacts

contacts[]

Contact persons tied to this gateway (name, email, phone).

common

Partially Obscured

partiallyObscured, partiallyObscuredDescription

Whether the gateway location is partially obscured.

common

Height Above Ground

heightAboveGround

Installed physical height.

common

UPS Available

upsAvailable

Indicates if a UPS (backup power) is available.

common

Easily Accessible

easyAccessible, easilyAccessibleDescription

Whether the gateway is easily accessible and description.

common

Remotely Power Cycle

remotelyPowerCycle

If the gateway can be power-cycled remotely.

common

Outdoor Antenna

outdoorAntenna

Indicates whether the gateway has an outdoor antenna.

common

Antenna Gain

antennaGain

Antenna gain specification (e.g., DBI2).

common

Antenna Cable Loss

antennaCableLoss

Signal loss introduced by the antenna cable.

common

Ethernet Connection Available

ethernetConnectionAvailable

Indicates whether ethernet connectivity is available.

common

LoRa Gateway EUI

loraGwEui

Unique EUI identifier for the LoRaWAN gateway.

loraGateway

Provisioned

loraGateway.provisioned

Whether the LoRa gateway is provisioned.

loraGateway

Provisioned Timestamp

provisionedTimestamp

Timestamp when provisioning occurred.

loraGateway

Network Server

networkServerId

ID of the network server the gateway is connected to.

loraGateway

Packet Forwarder

packetForwarder

Type of packet forwarder (e.g., CHIRPSTACK).

loraGateway

Frequency Plan

frequencyPlan

Frequency plan associated with this gateway.

loraGateway

Created

created

Timestamp when the gateway record was created.

common

Created By

createdBy

User who created the gateway record.

common

Last Updated

lastUpdated

Timestamp of the most recent update.

common

Last Updated By

lastUpdatedBy

User who last updated the gateway record.

common