Manual Page Search Parameters

SPACEPLANNER_API(1) General Commands Manual SPACEPLANNER_API(1)

spaceplanner_apiAPI for Spaceplanner

spaceplanner_api [-tsv] [-b bind_address] [-l logfile]

spaceplanner_api is the API for Spaceplanner.App's web interface. Initialize the database with spaceplanner_bootstrapdb(1) and spaceplanner_migratedb(1).

The options are described below:

Don't use Gin release mode.
Read configuration from stdin instead of /etc/spaceplanner/api.config.
bind_address
Bind to bind_address instead of using the FastCGI protocol.
logfile
Log messages to logfile instead of the stderr.
Display version and exit.

/etc/spaceplanner/api.config
Default configuration file.

The spaceplanner_api utility exits 0 on success, and >0 if an error occurs.

Run the API at 127.0.0.1 port 3600 and log to /var/log/spaceplanner.log:

$ spaceplanner_api -b 127.0.0.1:3600 -l /var/log/spaceplanner.log

spaceplanner_bootstrapdb(1), spaceplanner_migratedb(1)

Jacob R. Edwards <jacob@jacobedwards.org>

February 26, 2026 jacob