USusememos
InstanceService

GET /api/instance/profile

Changed on

GetInstanceProfile gets the instance profile. Available without authentication, including on a private instance.

Request

  • The document declares no server URL.
  • Auth
    none declared

Response

OK

versionstring

The version of the running server.

commitstring

The build commit of the running server.

demoboolean

Whether the instance runs in demo mode.

instanceUrlstring

The configured URL of the instance.

accessMode'INSTANCE_ACCESS_MODE_UNSPECIFIED' | 'INSTANCE_ACCESS_MODE_PRIVATE' | 'INSTANCE_ACCESS_MODE_PUBLIC' enum

Whether unauthenticated users may access instance content.

needsSetupboolean

Whether the instance has no users yet and requires initial setup (creating the first admin account). Unlike a null admin, this stays false once any user exists, so an instance that has lost its admins is not mistaken for a fresh install.

Changes