System info

GET

/api/system/info

const url = 'http://localhost:3000/api/system/info';
const options = {method: 'GET', headers: {cookie: 'session=<session>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url http://localhost:3000/api/system/info \
  --cookie session=<session>

Authenticated, admin-facing instance detail — the public instance fields plus process uptime.

Authorizations

cookieAuth

Responses

200

Success

application/json

object

data

object

version

required

string

edition

required

string

Allowed values: community cloud

orgName

required

Organisation name (cloud only); null when unset

string | null

uptime

required

Seconds since process start

number

Example

{
  "data": {
    "version": "0.1.0",
    "edition": "community"
  }
}

401

Not authenticated

application/json

object

error

required

string

Example

{
  "error": "Not found"
}