Karst Firewall 5.0 API Reference

Authenticates a user with the API app credentials and returns the user auth payload, including the bearer token when successful.

Creates a user account from the public signup payload. The response is true on success or validation details on failure.

Returns the authenticated user auth payload.

Accepts a bearer token in the Authorization header or authToken in the request body and returns fresh auth data. Rotation: the response carries a NEW authToken and the presented token only stays valid for a short overlap window, so clients must store the returned token.

Starts the password reset workflow for a user email address.

Completes a password reset with the token from the email workflow.

Lists active, non-deleted technology log rows through the TechnologyLogSearch data provider. Pass page=0 to disable pagination.

Creates a technology log row using the Yii REST ActiveController create action.

Reads a single technology log row by id.

Updates a technology log row. The REST controller accepts PUT for updates.

Marks a technology log as deleted when the model has a deleted attribute; otherwise deletes the row.

Returns Yii validation rules for the TechnologyLog model.

Maps a ChirpStack-style payload by deviceInfo.devEui to a Technology row and stores object data as a technology log.

Returns a paginated GeoJSON FeatureCollection of historical wildfire rows, optionally filtered by bbox=south,west,north,east.

Creates a calibration-export bundle for eligible simulation runs and responds with a redirect to the download endpoint.

Downloads a generated calibration export file by id.

Returns recent NDVI ingest runs, freshness and degradation metadata. Requires pyrowise.ndvi.view and the NDVI feature flag.

Returns NDVI observations for an AOI across a date window.

Returns the latest vegetation-health report for an AOI, including current band, anomaly and fuel-class breakdown when available.

Read-only active sensor inventory served to kf50-observation-ingest.

Read-only active sensor inventory served to kf50-observation-ingest.

Read-only active gateway inventory served to kf50-observation-ingest.

Read-only active gateway inventory served to kf50-observation-ingest.

Called by kf50-observation-ingest when it sees a paired sensor device_id that has not been announced yet.

Updates the last-known status projection for an already registered LoRaMIP gateway.

Updates denormalised last_* telemetry fields for one registered sensor.

Updates denormalised last_* telemetry fields for multiple registered sensors and returns a per-row report.

Idempotent per-reading sink used by kf50-observation-ingest for live MQTT history and explicit InfluxDB backfills.

Active placement campaigns, newest first, for the mobile app start screen. Returns headline fields plus per-status site counts, never the raw planner response.

One campaign plus every planned site — the LoRaMiP gateway mast and the e-nose sensors — each with its planned and (once confirmed) as-built coordinates. The optional assigned_to / status query filters narrow the sites to one crew member's queue; the plan summary still reflects the whole campaign.

The mobile app writeback for an install visit: the device serial scanned off the hardware and the as-built GPS position from the phone. The planned position never changes; the confirmed position lands in installed_lat/lon so plan-vs-built drift stays auditable. Idempotent for a site already installed; sites that are live or in a terminal state refuse with 409. If the scanned serial is already held by another non-terminal site the call returns 409 code=serial_conflict with the holding site; re-POST with reassign=true to move the serial here (the old site is walked back to procured and its as-built facts are preserved in the audit log).

Removes the sensor from a placement site: clears the device serial and as-built position and walks the site back to procured (device available, no longer placed). Idempotent — releasing an already-empty site is a no-op (released=false). Allowed from any lifecycle state; the extra confirmation for a live (transmitting) sensor is enforced by the app. The prior serial/position/state are preserved in the audit log.

The same sites as /placement-plan/{id}, serialized as a GeoJSON FeatureCollection so the mobile app can drop them straight onto flutter_map/MapLibre. Each feature carries planned/as-built coordinates, status colour and server-side plan-vs-built drift. The optional assigned_to / status query filters narrow the features to one crew member's queue.

Uploads one install photo (jpeg/png/webp ≤5 MB) for a placement site. Kept separate from /confirm so the offline app can retry the photo independently. Optional caption and as-built lat/lon may accompany the file. Supply client_uuid to make the retry safe: a replay returns the photo already stored (deduplicated=true) rather than a second copy.

Resolves one device by device_id or sensor_id_alias (the scanned QR may carry either) and returns its inventory record plus live freshness so the installer sees everything on scan. Responds 200 with {"found": false} when the serial is unknown.

Pre-loads the whole device batch (serials, optional placements, gateway) so scans resolve in the field. Upserts by device_id with a per-row report. approve:true sets discovery_state=approved so imported devices are immediately scan-resolvable.

The post-install "test connection" read: the denormalized last_* snapshot, freshness, gateway link, per-metric ok/warn/alert levels, and the last N sensor-log rows when present. The app polls this until freshness=live.

Exposes the already-ingested gateway health for the installer app's "validate gateway" step: network/mqtt/influx status, last-seen, and paired/pending-sync counts.

The maintenance app's work list: field-asset summaries with per-asset next_due_at, open-event count and overdue flag. Geo filter (near + radius_km) is a bounding-box prefilter plus haversine sort and returns distance_km; due/state filters narrow the queue.

Scan lookup: matches field_asset.serial or alias, and falls through iot_sensor.device_id → field_asset_id, so a device scanned in either mobile app resolves to the same physical asset. Returns the asset with its events, photos and taxonomy checklist template.

One field asset plus its recent maintenance events, photos and the taxonomy checklist template used to seed new events.

Opens a maintenance event against a field asset. The checklist is seeded from the taxonomy template when checklist_state is omitted; the event attributes to the authenticated user. Supply client_uuid to make the retry safe: a replay returns the event already opened rather than a second one.

Logs work on an open maintenance event: notes, downtime, parts cost, checklist state. Optimistically locked via row_version; a stale row_version returns 409 so the offline app can reload and merge.

Closes a maintenance event (ended_at=NOW()). Optional downtime, parts cost and next_due_at may be supplied at close. Idempotent for an already-completed event.

Uploads one image or PDF (≤8 MB) to a maintenance event. Returns the stored attachment with its mime and image/pdf flags. Supply client_uuid to make the retry safe: a replay returns the attachment already stored (deduplicated=true) rather than a second copy.

Called by kf50-dji-bridge when a DJI airframe serial is first seen. Idempotent: existing serials return the existing row.

Updates last battery, network, dock, mission and observation timestamp for a registered DJI airframe.

Creates an in-flight mission row linked to a registered DJI drone. mission_id is bridge-owned and must be unique.

Marks a mission ended and stores generated drone artefact URLs/counts.

Validates a drone-detected thermal hotspot, gates by confidence, calls PyroWISE nowcast, persists a simulation_run row, and links it to the DJI mission.