Skip to main content
GET
Identify the server

Response

200 - application/json

Server identity

name
enum<string>
required
Available options:
aboard
version
string
required

The server's release version, compared as a semantic version.

Example:

"0.1.0"

server_id
string
required
Pattern: ^srv_[0-9A-HJKMNP-TV-Z]{26}$
mode
enum<string>
required

local for a person's own server, team for one started with aboard serve --team at a public URL.

Available options:
local,
team
commit
string

The Git commit the server was built from, when known.

Example:

"881a92f4c3d1e0b2a7f6e5d4c3b2a1f0e9d8c7b6"

commit_time
string<date-time>

When that commit was made, when known. Between two builds with the same version, the one with the later commit_time is newer, and one without a commit_time is older than one with it.

features
string[]

What this server provides beyond the operations every server has, by name, so a client checks before using one and says server_outdated naming what is missing. Names are only added: tasks, asks, lines, files. Absent from servers that don't list features.

storage
object

The kinds of storage adapter the server runs, with no address, path or credential. Absent from servers before this was reported.