ChirpStack

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

Delete a device and everything ChirpStack stores about it.

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.

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

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`.

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

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

Discard every queued downlink for a device.

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

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

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

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.

Add devices to a deployment.

Create a FUOTA deployment from FuotaDeployment fields (snake_case, enums by name) plus the firmware as payload_hex or payload_base64. Byte fields (payload, fragmentation_descriptor) must come through payload_hex/payload_base64 and fragmentation_descriptor_hex, not `deployment`. Required fields: application_id, device_profile_id, name, multicast_group_type, multicast_dr, multicast_frequency.

Delete a FUOTA deployment.

Get a FUOTA deployment (payload is returned as hex).

List FUOTA deployments of an application.

List devices in a deployment with their per-device progress.

List the scheduler jobs of a deployment with attempts, warnings and errors.

Remove devices from a deployment.

Start a FUOTA deployment (schedules the multicast setup, fragmentation and transfer jobs).

Merge fields and/or replace the firmware payload of a deployment that has not started yet. Byte fields (payload, fragmentation_descriptor) must come through payload_hex/ payload_base64 and fragmentation_descriptor_hex, not `changes`. Map and repeated fields you supply in `changes` replace the whole field; omitted fields are kept.

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

Delete a gateway.

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

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

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

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

Remove an integration from an application.

Get one integration's configuration. Stored credentials (tokens, passwords, header values, etc.) are redacted unless include_secrets is true.

List which integrations an application has configured. `manageable` says whether integration_get/set/delete accept that `kind`.

Create or update an integration. config holds the snake_case fields of the matching ChirpStack message, per kind: http: event_endpoint_url, encoding, headers; influxdb: endpoint, db, username, password, retention_policy_name, precision, version, token, organization, bucket; thingsboard: server; mydevices: endpoint; gcp_pubsub: encoding, credentials_file, project_id, topic_name; aws_sns: encoding, region, access_key_id, secret_access_key, topic_arn; azure_service_bus: encoding, connection_string, publish_name; pilot_things: server, token; ifttt: key, uplink_values, arbitrary_json, event_prefix…

Add a device to a multicast group.

Create a multicast group from MulticastGroup fields (snake_case; enums by name: region "EU868", group_type "CLASS_C"). Required: application_id, name, region, mc_addr, mc_nwk_s_key, mc_app_s_key, group_type, dr, frequency.

Delete a multicast group.

Queue a multicast downlink (raw bytes only; multicast has no codec).

Get a multicast group. include_keys also reveals mc_nwk_s_key/mc_app_s_key.

List multicast groups of an application.

Discard queued multicast downlinks.

Show queued multicast downlinks.

Remove a device from a multicast group.

Merge the given MulticastGroup fields into an existing group; other fields are kept. Map and repeated fields you supply replace the whole field; omitted fields are kept. Session keys left as `<redacted>` (what multicast_get returns by default) keep the key already stored.

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.

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

Get a device profile including its payload codec script.

List device profiles of a tenant.

List the ADR algorithms available on this server.

List vendors from the imported device-profile catalogue.

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.

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.

Attach an end-device to a relay.

Get a relay gateway (4-byte relay id as hex).

List relay gateways of a tenant.

List devices acting as relays in an application.

List end-devices attached to a relay.

Detach an end-device from a relay.

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.

Create a tenant (0 for a count means unlimited).

Delete a tenant and everything under it.

Get a tenant.

List tenants visible to the API key.

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

Give an existing user (by e-mail) a role in a tenant.

List users of a tenant with their roles.

Remove a user from a tenant (the user account itself is kept).

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.