> ## Documentation Index
> Fetch the complete documentation index at: https://kaneo.app/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# Get system status

> 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.



## OpenAPI

````yaml /openapi.json get /admin/system
openapi: 3.1.0
info:
  title: Kaneo API
  version: 1.0.0
  description: Kaneo Project Management API - Manage projects, tasks, labels, and more
servers:
  - url: https://cloud.kaneo.app/api
    description: Kaneo API Server
security:
  - bearerAuth: []
paths:
  /admin/system:
    get:
      tags:
        - Admin
      summary: Get system status
      description: >-
        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.
      operationId: getAdminSystemStatus
      responses:
        '200':
          description: Status of this instance
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AdminSystemStatus'
        '401':
          description: Missing or invalid credentials
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
        '403':
          description: >-
            The caller lacks the instance permission or is authenticated with an
            API key
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
        '429':
          $ref: '#/components/responses/ApiKeyRateLimited'
components:
  schemas:
    AdminSystemStatus:
      type: object
      properties:
        checkedAt:
          type: string
          format: date-time
        version:
          type:
            - string
            - 'null'
          description: Kaneo release version of this API instance.
        api:
          type: object
          properties:
            status:
              type: string
              enum:
                - ok
                - warning
                - not_configured
                - down
              description: >-
                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:
              type: integer
            nodeVersion:
              type: string
          required:
            - status
            - uptimeSeconds
            - nodeVersion
        database:
          type: object
          properties:
            status:
              type: string
              enum:
                - ok
                - warning
                - not_configured
                - down
              description: >-
                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:
              type:
                - string
                - 'null'
            latencyMs:
              type:
                - integer
                - 'null'
            migrationsApplied:
              type:
                - integer
                - 'null'
            errorCode:
              type:
                - string
                - 'null'
              description: >-
                Short failure category such as TIMEOUT, ECONNREFUSED or
                HTTP_403. Never contains hosts, credentials or server messages.
          required:
            - status
            - serverVersion
            - latencyMs
            - migrationsApplied
            - errorCode
        realtime:
          type: object
          properties:
            status:
              type: string
              enum:
                - ok
                - warning
                - not_configured
                - down
              description: >-
                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:
              type:
                - string
                - 'null'
              enum:
                - in-memory
                - redis
                - null
              description: >-
                How events reach WebSocket clients: in-memory for a single
                instance, redis to fan out across instances. Null before
                WebSockets start.
            connections:
              type: integer
              description: Open WebSocket connections on this API instance.
            connectedUsers:
              type: integer
              description: Distinct people with an open connection to this instance.
          required:
            - status
            - adapter
            - connections
            - connectedUsers
        redis:
          type: object
          properties:
            status:
              type: string
              enum:
                - ok
                - warning
                - not_configured
                - down
              description: >-
                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:
              type:
                - string
                - 'null'
              enum:
                - standalone
                - sentinel
                - cluster
                - null
            errorCode:
              type:
                - string
                - 'null'
              description: >-
                Short failure category such as TIMEOUT, ECONNREFUSED or
                HTTP_403. Never contains hosts, credentials or server messages.
          required:
            - status
            - mode
            - errorCode
        email:
          type: object
          properties:
            status:
              type: string
              enum:
                - ok
                - warning
                - not_configured
                - down
              description: >-
                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:
              type: boolean
            errorCode:
              type:
                - string
                - 'null'
              description: >-
                Short failure category such as TIMEOUT, ECONNREFUSED or
                HTTP_403. Never contains hosts, credentials or server messages.
          required:
            - status
            - configured
            - errorCode
        storage:
          type: object
          properties:
            status:
              type: string
              enum:
                - ok
                - warning
                - not_configured
                - down
              description: >-
                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:
              type: boolean
            errorCode:
              type:
                - string
                - 'null'
              description: >-
                Short failure category such as TIMEOUT, ECONNREFUSED or
                HTTP_403. Never contains hosts, credentials or server messages.
          required:
            - status
            - configured
            - errorCode
        auth:
          type: object
          properties:
            passwordSignIn:
              type: boolean
            emailOtpSignIn:
              type: boolean
            registration:
              type: boolean
            passwordRegistration:
              type: boolean
            guestAccess:
              type: boolean
            workspaceCreation:
              type: boolean
            providers:
              type: array
              items:
                type: object
                properties:
                  id:
                    type: string
                    enum:
                      - github
                      - google
                      - discord
                      - custom
                  name:
                    type: string
                  status:
                    type: string
                    enum:
                      - ok
                      - warning
                      - not_configured
                      - down
                    description: >-
                      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.
                required:
                  - id
                  - name
                  - status
          required:
            - passwordSignIn
            - emailOtpSignIn
            - registration
            - passwordRegistration
            - guestAccess
            - workspaceCreation
            - providers
        integrations:
          type: array
          items:
            type: object
            properties:
              type:
                type: string
              name:
                type: string
              status:
                type: string
                enum:
                  - ok
                  - warning
                  - not_configured
                  - down
                description: >-
                  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:
                type: boolean
                description: >-
                  Whether the provider needs instance settings. Others are
                  connected per project.
              connectedProjects:
                type:
                  - integer
                  - 'null'
                description: >-
                  Projects with an active connection to this provider. Null when
                  the database could not be read.
            required:
              - type
              - name
              - status
              - requiresInstanceSetup
              - connectedProjects
      required:
        - checkedAt
        - version
        - api
        - database
        - realtime
        - redis
        - email
        - storage
        - auth
        - integrations
    ApiError:
      type: object
      properties:
        message:
          type: string
          description: Human-readable description of the error.
          example: Task not found
        code:
          type: string
          description: >-
            Stable UPPER_SNAKE_CASE code. Derived from the status unless a more
            specific code applies, such as VALIDATION_ERROR or
            MISSING_PERMISSION.
          example: NOT_FOUND
        issues:
          type: array
          items:
            type: object
            properties:
              path:
                type: string
                description: >-
                  Dotted path to the invalid input, prefixed with the request
                  part (body, query, params, header).
                example: body.title
              message:
                type: string
                example: Required
            required:
              - path
              - message
          description: Every validation issue, for VALIDATION_ERROR.
        missingPermissions:
          type: array
          items:
            type: string
          description: >-
            Permissions the caller lacks for this route, as resource:action, for
            MISSING_PERMISSION and API_KEY_SCOPE.
          example:
            - task:update
      required:
        - message
        - code
  responses:
    ApiKeyRateLimited:
      description: >-
        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.
      headers:
        Retry-After:
          description: >-
            Seconds to wait before retrying. Omitted when an exhausted usage
            quota never refills.
          schema:
            type: integer
        X-RateLimit-Limit:
          description: Requests the API key may make per window.
          schema:
            type: integer
        X-RateLimit-Remaining:
          description: Requests left in the current window.
          schema:
            type: integer
        X-RateLimit-Reset:
          description: Unix time in seconds when the current window resets.
          schema:
            type: integer
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ApiError'
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: API key or session token (Bearer)

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.