---
title: "Get the administration overview"
method: GET
path: "/admin/overview"
tags: ["Admin"]
---

# Get the administration overview

`GET /admin/overview`

## Request

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

User and workspace counts, the five newest users and administrative actions, compact service checks, and configuration warnings. Activity is based on session refreshes within 30 days and excludes deactivated accounts. Requires all four instance permissions: `users:read`, `workspaces:read`, `audit:read`, and `system:read`; API keys are rejected. No credentials or audit metadata are returned.

## Response `200`

Instance overview

- AdminOverview
  - `users` object, required
    - `total` integer, required
    - `activeLast30Days` integer, required: Non-deactivated users with a session refreshed in the last 30 days, counted once per user. Expired bans do not deactivate an account. Revoked or removed sessions do not contribute.
    - `deactivated` integer, required
  - `workspaces` object, required
    - `total` integer, required
    - `archived` integer, required
  - `recentUsers` object[], required
    - `id` string, required
    - `name` string, required
    - `email` string, required
    - `image` string, nullable, required
    - `createdAt` string, date-time, required
  - `recentActions` object[], required
    - `id` string, required
    - `createdAt` string, date-time, required
    - `action` string, required: Dotted action name, for example `user.role_changed`.
    - `actor` object, required
      - `id` string, nullable, required: Null when the administrator's account was deleted.
      - `name` string, nullable, required
      - `email` string, nullable, required
    - `targetType` string, required
    - `targetId` string, nullable, required
    - `targetLabel` string, nullable, required: The target's name or email when the action happened.
  - `services` object, required
    - `checkedAt` string, date-time, required
    - `api` '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.
    - `database` '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.
    - `realtime` '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.
    - `redis` '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.
    - `email` '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.
    - `storage` '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.
  - `warnings` string[], required

## Other responses

- `401`: Authentication required
- `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-27** `bbaae0ea62c6`: 1 info
  - endpoint added

[Operation history](https://skmtc.dev/usekaneo/apis/kaneo-api/changes/admin/overview/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)