Skip to content

Latest commit

 

History

History
64 lines (43 loc) · 1.67 KB

dmapi.adoc

File metadata and controls

64 lines (43 loc) · 1.67 KB

dmapi(1) Manual Page

NAME

dmapi - FastCGI-based HTTP-RPC service for database access

SYNOPSIS

dmapi

DESCRIPTION

dmapi is an HTTP-RPC service for remote DMPACK database access. The web application has to be executed by a FastCGI-compatible web server or a FastCGI spawner. It is recommended to run dmapi in lighttpd(1).

The dmapi service offers endpoints for clients to insert nodes, sensors, targets, observations, logs, and beats into the server SQLite databases, and to retrieve the data in CSV, JSON, or JSON Lines format. Authentication and encryption are independent from dmapi and have to be provided by the environment.

The POST data sent by clients must be serialised in Fortran 95 Namelist format, with optional deflate or zstd compression. The content type and the content encoding have to be passed in the HTTP header of the request.

If HTTP Basic Auth is enabled, the sensor id of each beat, log, node, sensor, and observation sent to the RPC service must match the name of the authenticated user, otherwise, the data will be rejected (HTTP 401).

ENVIRONMENT

Add the following environment variables to the configuration of the web server or spawner to pass them to dmapi:

DM_DB_BEAT

Path to heartbeat database.

DM_DB_LOG

Path to log database.

DM_DB_OBSERV

Path to observation database.

DM_READ_ONLY

Set to 1 to open databases in read-only mode.

SEE ALSO

dmbeat(1), dmsync(1)

RESOURCES

Project web site: https://www.dabamos.de/

COPYING

Copyright © 2024 Philipp Engel.
Free use of this software is granted under the terms of the ISC Licence.