---
title: "Get system status"
method: GET
path: "/admin/system"
tags: ["Admin"]
---

# Get system status

`GET /admin/system`

## Request

- Base URL: `https://cloud.kaneo.app/api`
- URL: `https://cloud.kaneo.app/api/admin/system`
- Auth: HTTP bearer

Check this API instance and the services it uses: version, uptime, database, WebSockets, Redis fan-out, SMTP, object storage, sign-in providers and integration providers. Each check gives up after a few seconds, so one unreachable service can't block the response. Only statuses, counts and short error categories are returned, never hosts, credentials or secrets. Requires the `system:read` instance permission; API keys are rejected.

## Response `200`

Status of this instance

- AdminSystemStatus
  - `checkedAt` string, date-time, required
  - `version` string, nullable, required: Kaneo release version of this API instance.
  - `api` object, required
    - `status` 'ok' | 'warning' | 'not_configured' | 'down', required: ok: working. warning: works with a problem, or is only partly configured. not_configured: optional and switched off, which is a healthy state. down: configured but not reachable.
    - `uptimeSeconds` integer, required
    - `nodeVersion` string, required
  - `database` object, required
    - `status` 'ok' | 'warning' | 'not_configured' | 'down', required: ok: working. warning: works with a problem, or is only partly configured. not_configured: optional and switched off, which is a healthy state. down: configured but not reachable.
    - `serverVersion` string, nullable, required
    - `latencyMs` integer, nullable, required
    - `migrationsApplied` integer, nullable, required
    - `errorCode` string, nullable, required: Short failure category such as TIMEOUT, ECONNREFUSED or HTTP_403. Never contains hosts, credentials or server messages.
  - `realtime` object, required
    - `status` 'ok' | 'warning' | 'not_configured' | 'down', required: ok: working. warning: works with a problem, or is only partly configured. not_configured: optional and switched off, which is a healthy state. down: configured but not reachable.
    - `adapter` 'in-memory' | 'redis' | 'null', nullable, required: How events reach WebSocket clients: in-memory for a single instance, redis to fan out across instances. Null before WebSockets start.
    - `connections` integer, required: Open WebSocket connections on this API instance.
    - `connectedUsers` integer, required: Distinct people with an open connection to this instance.
  - `redis` object, required
    - `status` 'ok' | 'warning' | 'not_configured' | 'down', required: ok: working. warning: works with a problem, or is only partly configured. not_configured: optional and switched off, which is a healthy state. down: configured but not reachable.
    - `mode` 'standalone' | 'sentinel' | 'cluster' | 'null', nullable, required
    - `errorCode` string, nullable, required: Short failure category such as TIMEOUT, ECONNREFUSED or HTTP_403. Never contains hosts, credentials or server messages.
  - `email` object, required
    - `status` 'ok' | 'warning' | 'not_configured' | 'down', required: ok: working. warning: works with a problem, or is only partly configured. not_configured: optional and switched off, which is a healthy state. down: configured but not reachable.
    - `configured` boolean, required
    - `errorCode` string, nullable, required: Short failure category such as TIMEOUT, ECONNREFUSED or HTTP_403. Never contains hosts, credentials or server messages.
  - `storage` object, required
    - `status` 'ok' | 'warning' | 'not_configured' | 'down', required: ok: working. warning: works with a problem, or is only partly configured. not_configured: optional and switched off, which is a healthy state. down: configured but not reachable.
    - `configured` boolean, required
    - `errorCode` string, nullable, required: Short failure category such as TIMEOUT, ECONNREFUSED or HTTP_403. Never contains hosts, credentials or server messages.
  - `auth` object, required
    - `passwordSignIn` boolean, required
    - `emailOtpSignIn` boolean, required
    - `registration` boolean, required
    - `passwordRegistration` boolean, required
    - `guestAccess` boolean, required
    - `workspaceCreation` boolean, required
    - `providers` object[], required
      - `id` 'github' | 'google' | 'discord' | 'custom', required
      - `name` string, required
      - `status` 'ok' | 'warning' | 'not_configured' | 'down', required: ok: working. warning: works with a problem, or is only partly configured. not_configured: optional and switched off, which is a healthy state. down: configured but not reachable.
  - `integrations` object[], required
    - `type` string, required
    - `name` string, required
    - `status` 'ok' | 'warning' | 'not_configured' | 'down', required: ok: working. warning: works with a problem, or is only partly configured. not_configured: optional and switched off, which is a healthy state. down: configured but not reachable.
    - `requiresInstanceSetup` boolean, required: Whether the provider needs instance settings. Others are connected per project.
    - `connectedProjects` integer, nullable, required: Projects with an active connection to this provider. Null when the database could not be read.

## Other responses

- `401`: Missing or invalid credentials
- `403`: The caller lacks the instance permission or is authenticated with an API key
- `429`: The API key exceeded its rate limit or usage quota. Wait the number of seconds in Retry-After before retrying. The X-RateLimit headers are sent only when the rate limit was hit.

## Changes

- **2026-10-28** `bbaae0ea62c6`: 1 info
  - endpoint added
- **2026-10-28** `d7d92f47083a`: 1 breaking
  - api path removed without deprecation
- **2026-10-28** `6d2e646045ea`: 1 info
  - endpoint added
- **2026-10-28** `270c2866a46a`: 1 breaking
  - api path removed without deprecation
- **2026-10-28** `8cf55c967f4c`: 1 info
  - endpoint added

[Operation history](https://skmtc.dev/usekaneo/apis/kaneo-api/changes/admin/system/get.md)

---

[API](https://skmtc.dev/usekaneo/apis/kaneo-api.md) - [All operations](https://skmtc.dev/usekaneo/apis/kaneo-api/llms.txt) - [OpenAPI document](https://skmtc.dev/usekaneo/apis/kaneo-api/revisions/741a49dfb347?raw)