Instance info

GET

/api/instance

const url = 'http://localhost:3000/api/instance';
const options = {method: 'GET'};

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/instance

Public instance metadata for the sign-in screen, served before a session exists. Deliberately excludes uptime and process internals.

Responses

200

Instance metadata

application/json

object

version

required

string

edition

required

string

Allowed values: community cloud

orgName

required

Organisation name shown on the sign-in screen (cloud only); null when unset

string | null

Example

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