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

# System status

> Returns the current maintenance state: active maintenance periods and the active announcement.

This endpoint is always exempt from maintenance blocking. Poll it every 30 seconds to drive frontend maintenance banners and overlays.

The `maintenance.periods` list is pre-filtered for the caller: authenticated requests receive only periods that apply to their company; unauthenticated requests receive only instance-wide periods. Company IDs are never exposed in the response.



## OpenAPI

````yaml /api-reference/openapi-v3.yaml get /api/v3/system/status
openapi: 3.1.0
info:
  title: LightOn API
  version: 3.15.0 (v3)
  description: >-
    LightOn gives you an API to search, parse, and ingest documents at scale.
    Build knowledge-retrieval pipelines without managing vector databases or OCR
    models.
servers:
  - url: https://paradigm.lighton.ai
security: []
tags:
  - name: Agents
    description: Operations about agents
  - name: Threads
    description: Operations about agents conversation threads
  - name: Tools
    description: Operations about native tools
  - name: Models
    description: Operations about AI models
  - name: MCP
    description: Operations about MCP servers
  - name: Sources
    description: Operations about sources used by agents conversation threads
  - name: Artifacts
    description: Operations about artifacts generated by agents conversation threads
  - name: Agent
    description: >-
      Operations about agents (deprecated). Please use the 'Agents' API
      component instead.
  - name: Files
    description: Operations about files
  - name: Facets
    description: Operations about facets
  - name: Tags
    description: Operations about tags
  - name: Workspaces
    description: Operations about workspaces
  - name: Files Processing
    description: Operations about files processing
  - name: Users
    description: Operations about users
  - name: API Keys
    description: Operations about API keys
  - name: User Groups
    description: Operations about user groups
  - name: SCIM
    description: Operations about SCIM
paths:
  /api/v3/system/status:
    get:
      tags:
        - System
      summary: System status
      description: >-
        Returns the current maintenance state: active maintenance periods and
        the active announcement.


        This endpoint is always exempt from maintenance blocking. Poll it every
        30 seconds to drive frontend maintenance banners and overlays.


        The `maintenance.periods` list is pre-filtered for the caller:
        authenticated requests receive only periods that apply to their company;
        unauthenticated requests receive only instance-wide periods. Company IDs
        are never exposed in the response.
      operationId: api_v3_system_status_retrieve
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SystemStatus'
              examples:
                NoMaintenance:
                  value:
                    maintenance:
                      active: false
                      periods: []
                    announcement:
                      active: false
                  summary: No maintenance
                GlobalMaintenance:
                  value:
                    maintenance:
                      active: true
                      periods:
                        - frontend_mode: full_shutdown
                          reason: Database upgrade
                          started_at: '2026-06-22T22:00:00Z'
                    announcement:
                      active: true
                      message: >-
                        We will be upgrading the database. The platform will be
                        unavailable.
                      expected_start: '2026-06-22T22:00:00Z'
                      expected_end: '2026-06-23T06:00:00Z'
                  summary: Global maintenance
                ScopedMaintenance(authenticated):
                  value:
                    maintenance:
                      active: true
                      periods:
                        - endpoint_category_names:
                            - Search & Ask
                          frontend_mode: warning_banner
                          reason: Model endpoint update
                          started_at: '2026-06-22T22:00:00Z'
                    announcement:
                      active: false
                  summary: Scoped maintenance (authenticated)
          description: Current system maintenance state.
components:
  schemas:
    SystemStatus:
      type: object
      properties:
        maintenance:
          allOf:
            - $ref: '#/components/schemas/_MaintenanceStatus'
          readOnly: true
        announcement:
          allOf:
            - $ref: '#/components/schemas/_AnnouncementStatus'
          readOnly: true
      required:
        - announcement
        - maintenance
    _MaintenanceStatus:
      type: object
      description: Schema-only serializer for drf-spectacular introspection.
      properties:
        active:
          type: boolean
        periods:
          type: array
          items:
            $ref: '#/components/schemas/MaintenancePeriod'
      required:
        - active
        - periods
    _AnnouncementStatus:
      type: object
      description: Schema-only serializer for drf-spectacular introspection.
      properties:
        active:
          type: boolean
        message:
          type: string
        expected_start:
          type:
            - string
            - 'null'
          format: date-time
        expected_end:
          type:
            - string
            - 'null'
          format: date-time
      required:
        - active
    MaintenancePeriod:
      type: object
      properties:
        endpoint_category_names:
          description: >-
            Human-readable category names for the selected endpoint groups. E.g.
            ["Indexing & Parsing"]
        frontend_mode:
          $ref: '#/components/schemas/FrontendModeEnum'
        reason:
          type: string
          maxLength: 500
        started_at:
          type: string
          format: date-time
          readOnly: true
      required:
        - started_at
    FrontendModeEnum:
      enum:
        - full_shutdown
        - warning_banner
      type: string
      description: |-
        * `full_shutdown` - Full Shutdown
        * `warning_banner` - Warning Banner

````