The Things Network / The Things Stack JsEndDeviceRegistry API
The JsEndDeviceRegistry API from The Things Network / The Things Stack — 5 operation(s) for jsenddeviceregistry.
The Things Network / The Things Stack JsEndDeviceRegistry 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 JsEndDeviceRegistry. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and 9 JSON Schemas.
This API exposes 5 operations across 5 paths, and defines 169 schemas. It is described by OpenAPI 2.0, at version v3.36.
5 operations
5 paths
169 schemas
1 DELETE1 GET1 POST2 PUT
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 1
The Things Network / The Things Stack JsEndDeviceRegistry 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 5
Across 5 paths, the API surfaces 5 operations — 1 DELETE, 1 GET, 1 POST, 2 PUT. Each is listed below with its method, path, parameters, and response codes.
JsEndDeviceRegistry 5
DELETE
/js/applications/{application_ids.application_id}/devices/{device_id}
Delete deletes the device that matches the given identifiers. If there are multiple matches, an error will be returned.
PUT
/js/applications/{application_ids.application_id}/provision-devices
This rpc is deprecated; use EndDeviceTemplateConverter service instead. TODO: Remove (https://github.com/TheThingsNetwork/lorawan-stack/issues/999)
POST
/js/applications/{end_device.ids.application_ids.application_id}/devices
Set creates or updates the device.
PUT
/js/applications/{end_device.ids.application_ids.application_id}/devices/{end_device.ids.device_id}
Set creates or updates the device.
GET
/js/applications/{end_device_ids.application_ids.application_id}/devices/{end_device_ids.device_id}
Get returns the device that matches the given identifiers. If there are multiple matches, an error will be returned.
Schemas 169
The contract defines 169 schemas that model the data the API accepts and returns. The most detailed are v3EndDevice (54 properties), v3MACCommand (43 properties), v3MACSettings (36 properties), v3MACState (24 properties). Each schema is shown below with its type and property counts.
v3ADRAckLimitExponentValue
object
1 property
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…
v3MType
string
v3NetworkIdentifiers
object
Identifies a Network Server.
6 properties
v3ADRSettingsDisabledMode
object
Configuration options for cases in which ADR is to be disabled completely.
MACCommandRejoinParamSetupAns
object
1 property
MACCommandTxParamSetupReq
object
3 properties
v3DataRateIndex
string
ADRSettingsDynamicMode
object
Configuration options for dynamic ADR.
9 properties
MACStateDataRateRange
object
2 properties
MACCommandRelayConfAns
object
6 properties
v3RelayUplinkForwardingRule
object
4 properties
DownlinkMessageMessageMHDR
object
1 property
v3EndDevice
object
Defines an End Device registration and its state on the network. The persistence of the EndDevice is divided between the Network Server, Application Server and…
54 properties
MACCommandRelayConfigureFwdLimitAns
object
v3PingSlotPeriod
string
- PINGEVERY1S: Every second. - PINGEVERY2S: Every 2 seconds. - PINGEVERY4S: Every 4 seconds. - PINGEVERY8S: Every 8 seconds. - PINGEVERY16S: Every 16 seconds.…
v3DeviceEIRP
string
- DEVICEEIRP8: 8 dBm. - DEVICEEIRP10: 10 dBm. - DEVICEEIRP12: 12 dBm. - DEVICEEIRP13: 13 dBm. - DEVICEEIRP14: 14 dBm. - DEVICEEIRP16: 16 dBm. - DEVICEEIRP18: 1…
MACStateDataRateRanges
object
1 property
MACCommandLinkADRAns
object
3 properties
v3Class
string
v3FCtrl
object
5 properties
MACCommandRxTimingSetupReq
object
1 property
ADRSettingsStaticMode
object
Configuration options for static ADR.
3 properties
v3DataRateIndexValue
object
1 property
v3PingSlotPeriodValue
object
1 property
v3MACState
object
MACState represents the state of MAC layer of the device. MACState is reset on each join for OTAA or ResetInd for ABP devices. This is used internally by the N…
24 properties
MACCommandADRParamSetupReq
object
2 properties
v3MACSettings
object
36 properties
v3ADRAckDelayExponentValue
object
1 property
DownlinkMessageMessageMACPayload
object
2 properties
MACStateJoinAccept
object
6 properties
v3DataRate
object
3 properties
MACCommandRelayEndDeviceConfReqConfiguration
object
6 properties
v3FSKDataRate
object
1 property
MACCommandBeaconFreqReq
object
1 property
v3PHYVersion
string
v3MACSettingsProfileIdentifiers
object
2 properties
MACCommandForceRejoinReq
object
4 properties
MACCommandRelayNotifyNewEndDeviceReq
object
3 properties
MACCommandRxParamSetupReq
object
3 properties
v3JoinAcceptPayload
object
7 properties
v3ADRAckDelayExponent
string
googlerpcStatus
object
3 properties
v3RelaySecondChAckOffset
string
MACCommandRelayUpdateUplinkListAns
object
v3RelaySettings
object
RelaySettings represent the settings of a relay. This is used internally by the Network Server.
2 properties
v3JoinRequestPayload
object
3 properties
v3ServingRelayParameters
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
MACCommandRelayConfReqConfiguration
object
3 properties
v3DLSettings
object
3 properties
v3RejoinRequestPayload
object
5 properties
v3RejoinPeriodExponent
string
- REJOINPERIOD0: Every 32 to 64 seconds. - REJOINPERIOD1: Every 64 to 96 seconds. - REJOINPERIOD2: Every 128 to 160 seconds. - REJOINPERIOD3: Every 256 to 288…
v3ADRAckLimitExponent
string
v3MACStateUplinkMessage
object
A minimal UplinkMessage definition which is binary compatible with the top level UplinkMessage message. Used for type safe recent uplink storage.
6 properties
v3TxSchedulePriority
string
ProvisionEndDevicesRequestIdentifiersRange
object
2 properties
PictureEmbedded
object
2 properties
ChannelSteeringSettingsLoRaNarrowMode
object
Configuration options for LoRa narrow channels steering. The narrow mode attempts to steer the end device towards using the LoRa modulated, 125kHz bandwidth ch…
JsEndDeviceRegistryProvisionBody
object
6 properties
MACCommandRelayCtrlUplinkListReq
object
2 properties
v3MACCommandIdentifier
string
v3MACCommand
object
43 properties
MACCommandResetInd
object
1 property
MACStateUplinkMessageRxMetadata
object
7 properties
ApplicationDownlinkClassBC
object
2 properties
v3MACStateDownlinkMessage
object
A minimal DownlinkMessage definition which is binary compatible with the top level DownlinkMessage message. Used for type safe recent downlink storage.
2 properties
MACStateDownlinkMessageMessage
object
2 properties
lorawanv3Location
object
5 properties
v3RootKeys
object
Root keys for a LoRaWAN device. These are stored on the Join Server.
3 properties
MACCommandPingSlotChannelAns
object
2 properties
MACCommandDLChannelReq
object
2 properties
ProvisionEndDevicesRequestIdentifiersFromData
object
1 property
v3ADRSettings
object
Adaptive Data Rate settings.
3 properties
MACCommandRekeyInd
object
1 property
UplinkMessageRxMetadataPacketBrokerMetadata
object
v3DeviceEIRPValue
object
1 property
ProvisionEndDevicesRequestIdentifiersList
object
2 properties
v3DataRateOffsetValue
object
1 property
v3RelayResetLimitCounter
string
ApplicationDownlinkConfirmedRetry
object
2 properties
MACCommandDLChannelAns
object
2 properties
v3ServedRelaySettings
object
6 properties
v3RelayCtrlUplinkListAction
string
MACCommandDeviceModeConf
object
1 property
v3JsEndDeviceRegistrySetBody
object
2 properties
v3RelayLimitBucketSize
string
MACCommandDeviceModeInd
object
1 property
v3ApplicationDownlink
object
15 properties
v3ServedRelayParameters
object
6 properties
v3ClassBCGatewayIdentifiers
object
3 properties
v3MACParameters
object
MACParameters represent the parameters of the device's MAC layer (active or desired). This is used internally by the Network Server.
23 properties
v3RelayEndDeviceControlledMode
object
lorawanv3MACPayload
object
5 properties
v3Session
object
8 properties
DynamicModeChannelSteeringSettingsDisabledMode
object
Configuration options for cases in which ADR is not supposed to steer the end device to another set of channels.
v3RejoinCountExponent
string
v3RxDelay
string
- RXDELAY0: 1 second. - RXDELAY1: 1 second. - RXDELAY2: 2 seconds. - RXDELAY3: 3 seconds. - RXDELAY4: 4 seconds. - RXDELAY5: 5 seconds. - RXDELAY6: 6 seconds.…
MACCommandRejoinParamSetupReq
object
2 properties
v3ServingRelayForwardingLimits
object
5 properties
MACCommandRxParamSetupAns
object
3 properties
MACCommandResetConf
object
1 property
DynamicModePerDataRateIndexOverride
object
EXPERIMENTAL: Data rate index override settings.
2 properties
v3MACVersion
string
v3CFListType
string
MACCommandLinkCheckAns
object
2 properties
MACCommandBeaconFreqAns
object
1 property
MACCommandDutyCycleReq
object
1 property
MACCommandRekeyConf
object
1 property
v3Minor
string
v3RelayForwardDownlinkReq
object
1 property
v3RelayEndDeviceDynamicMode
object
1 property
MACCommandRelayConfigureFwdLimitReq
object
5 properties
MACCommandDeviceTimeAns
object
1 property
v3AggregatedDutyCycle
string
- DUTYCYCLE1: 100%. - DUTYCYCLE2: 50%. - DUTYCYCLE4: 25%. - DUTYCYCLE8: 12.5%. - DUTYCYCLE16: 6.25%. - DUTYCYCLE32: 3.125%. - DUTYCYCLE64: 1.5625%. - DUTYCYCLE…
lorawanv3MHDR
object
2 properties
MACCommandRelayUpdateUplinkListReq
object
7 properties
v3Major
string
v3SessionKeys
object
Session keys for a LoRaWAN session. Only the components for which the keys were meant, will have the key-encryption-key (KEK) to decrypt the individual keys.
5 properties
v3ApplicationIdentifiers
object
1 property
v3RelayUplinkForwardLimits
object
2 properties
v3DownlinkPathConstraint
string
- DOWNLINKPATHCONSTRAINTNONE: Indicates that the gateway can be selected for downlink without constraints by the Network Server. - DOWNLINKPATHCONSTRAINTPREFER…
v3RejoinTimeExponent
string
- REJOINTIME0: Every ~17.1 minutes. - REJOINTIME1: Every ~34.1 minutes. - REJOINTIME2: Every ~1.1 hours. - REJOINTIME3: Every ~2.3 hours. - REJOINTIME4: Every…
lorawanv3Message
object
6 properties
v3LRFHSSDataRate
object
3 properties
v3RelayEndDeviceAlwaysMode
object
v3ServingRelaySettings
object
5 properties
v3EndDeviceVersionIdentifiers
object
Identifies an end device model with version information.
5 properties
v3RelayCADPeriodicity
string
MACCommandBeaconTimingAns
object
2 properties
v3RxDelayValue
object
1 property
v3LoRaDataRate
object
3 properties
DynamicModeOverrides
object
EXPERIMENTAL: Configuration overrides.
16 properties
lorawanv3GatewayIdentifiers
object
2 properties
v3RelayForwardLimits
object
2 properties
MACCommandPingSlotInfoReq
object
1 property
MACCommandNewChannelReq
object
4 properties
v3FrequencyValue
object
1 property
v3PowerState
string
Power state of the device.
v3LoRaAllianceProfileIdentifiers
object
2 properties
v3PayloadFormatter
string
- FORMATTERNONE: No payload formatter to work with raw payload only. - FORMATTERREPOSITORY: Use payload formatter for the end device type from a repository. -…
v3RelaySecondChannel
object
3 properties
v3EndDeviceIdentifiers
object
5 properties
v3RejoinRequestType
string
- CONTEXT: Resets DevAddr, Session Keys, Frame Counters, Radio Parameters. - SESSION: Equivalent to the initial JoinRequest. - KEYS: Resets DevAddr, Session Ke…
MACCommandRelayEndDeviceConfAns
object
4 properties
v3ZeroableFrequencyValue
object
1 property
v3KeyEnvelope
object
3 properties
MACCommandRelayCtrlUplinkListAns
object
2 properties
lorawanv3RelayParameters
object
RelayParameters represent the parameters of a relay. This is used internally by the Network Server.
2 properties
v3FHDR
object
4 properties
MACCommandRelayEndDeviceConfReq
object
1 property
v3MACParametersChannel
object
5 properties
v3MACStateJoinRequest
object
3 properties
MACCommandRelayConfReq
object
1 property
v3AggregatedDutyCycleValue
object
1 property
MACCommandNewChannelAns
object
2 properties
UplinkMessageRxMetadataRelayMetadata
object
v3CFList
object
3 properties
lorawanv3BoolValue
object
1 property
MACCommandPingSlotChannelReq
object
2 properties
v3RelaySmartEnableLevel
string
v3DataRateOffset
string
MACCommandLinkADRReq
object
5 properties
v3MessagePayloadFormatters
object
4 properties
MACStateUplinkMessageTxSettings
object
1 property
v3EndDeviceAuthenticationCode
object
Authentication code for end devices.
3 properties
MACCommandDevStatusAns
object
2 properties
DynamicModeChannelSteeringSettings
object
EXPERIMENTAL: Channel steering settings.
2 properties
v3Picture
object
2 properties
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from The Things Network / The Things Stack 12
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
#JsEndDeviceRegistry