List devices in an application (optionally filtered by a search string).

Get a device with its current activation (session) and, if include_keys, its OTAA root keys. include_keys also reveals the session keys in activation.

Create a device. Set OTAA keys afterwards with device_set_keys, or ABP session with device_activate.

Update only the given fields of a device; omitted fields keep their current values. Supplying tags replaces the whole tag map. Supplying variables replaces the whole variable map.

Delete a device and everything ChirpStack stores about it.

Create or replace the OTAA root keys. LoRaWAN 1.0.x devices use nwk_key only (their AppKey goes in nwk_key).

ABP-activate a device (or reset an OTAA session). For LoRaWAN 1.0.x pass nwk_s_enc_key only; the other two network keys default to it.

Drop the device session; an OTAA device must re-join before it can communicate.

Forget used DevNonces so a device whose join-requests are rejected as replays can join again.

Queue a downlink. Give the payload as data_hex, data_base64, or object (encoded by the profile codec). Class A devices receive it after their next uplink.

Show downlinks waiting for (or pending confirmation from) a device.

Discard every queued downlink for a device.

Link quality (RSSI, SNR, packets per frequency/DR, errors) plus codec-defined device metrics. Defaults to the last 24 hours.

Check the connection and the API key. Version and regions are only available to user sessions in ChirpStack, so they may be null/empty with an API key.

Start a background capture of a device's events/frames or a gateway's frames. Returns a session_id; read incrementally with capture_read. Sessions idle for 30 minutes are dropped.

Read captured items with seq > since_seq. Remember last_seq and pass it back next time. Check stream_state for reconnects. Each item carries live: false means ChirpStack replayed it from before the session started, true means it happened while the session was open.

Stop a capture session and discard its buffer.

List capture sessions, including ones stopped by a terminal error (stream_state starts with stopped:).

Block until the device emits a live event (optionally of the given types: up, join, ack, txack, log, status, location) or the timeout (max 60 s) passes. Only events newer than the moment of the call count (live); the events ChirpStack replays from its history never satisfy the wait, whatever their arrival timing. Use device_recent_events for those.

One-shot look at the last few events (or frames) ChirpStack still holds for a device - typically the last 10.

List applications of a tenant.

Get an application.

Create an application in a tenant.

Update only the given fields of an application. Supplying tags replaces the whole tag map.

Delete an application and all of its devices.

List the distinct device tag keys and values used inside an application.

List device profiles of a tenant.

Get a device profile including its payload codec script.

Create a device profile from a dict of DeviceProfile fields (snake_case; enums by name, e.g. region "EU868", mac_version "LORAWAN_1_0_3", reg_params_revision "A"). Required: tenant_id, name, region, mac_version, reg_params_revision.

Merge the given DeviceProfile fields into an existing profile; other fields are kept. Map and repeated fields you supply (e.g. tags, measurements) replace the whole field; omitted fields are kept.

Delete a device profile (fails while devices still use it).

Replace only the payload codec of a profile. For runtime JS, script is required and must define decodeUplink(input) and may define encodeDownlink(input); use runtime NONE to turn the codec off. Iterate here while watching uplinks with capture_read.

List vendors from the imported device-profile catalogue.

List the ADR algorithms available on this server.

List gateways (all tenants when tenant_id is empty and the key is a global admin key).

Get a gateway with its last-seen time and location.

Register a gateway; location is set only when coordinates are given.

Update only the given fields of a gateway. Supplying tags replaces the whole tag map.

Delete a gateway.

RX/TX packet counts per frequency, DR and status, plus duty-cycle usage. Defaults to the last 24 hours.