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

# List components

> Every enabled monitored component with its current status and 90 day uptime. Host names and check targets are never exposed.

**Permission:** `modules.status.read`



## OpenAPI

````yaml /docs/modules-api.yaml get /application/modules/status/components
openapi: 3.1.0
info:
  title: Spartan Module API
  version: '2026.11'
  description: >-
    Endpoints added by modules. Key endpoints live under
    `/api/application/modules/<module>/` and need an API key with the module
    permission. Content modules (Blog, News, Knowledge Base, Status) also offer
    keyless read only endpoints under `/api/public/modules/<module>/` that only
    return what an anonymous visitor can see.
servers:
  - url: https://{domain}/api
    description: Your Spartan installation
    variables:
      domain:
        default: billing.example.com
        description: Domain of your Spartan installation, without https://
security:
  - bearerAuth: []
tags:
  - name: Blog
  - name: Blog (public)
  - name: News
  - name: News (public)
  - name: Knowledge Base
  - name: Knowledge Base (public)
  - name: Status
  - name: Status (public)
  - name: Forms
  - name: Affiliates
  - name: Deprecated endpoints
paths:
  /application/modules/status/components:
    get:
      tags:
        - Status
      summary: List components
      description: >-
        Every enabled monitored component with its current status and 90 day
        uptime. Host names and check targets are never exposed.


        **Permission:** `modules.status.read`
      operationId: listStatusComponents
      parameters:
        - name: include_history
          in: query
          required: false
          schema:
            type: boolean
            default: false
          description: Add the daily history of the last 90 days.
      responses:
        '200':
          description: Success.
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/StatusComponent'
                  meta:
                    $ref: '#/components/schemas/Meta'
                required:
                  - data
                  - meta
              example:
                data:
                  - id: 1
                    label: Game servers Frankfurt
                    description: null
                    category: Servers
                    icon: null
                    status: online
                    is_online: true
                    under_maintenance: false
                    has_data: true
                    response_time: 30
                    last_checked_at: '2026-11-16T15:35:08Z'
                    uptime_percentage: 100
                meta:
                  request_id: bc7c3990-7ce3-4239-9fd8-70d16bba8a37
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '422':
          description: Validation failed.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationError'
              examples:
                validation_failed:
                  summary: Invalid input
                  value:
                    error:
                      code: validation_failed
                      message: The request data is invalid.
                      details:
                        per_page:
                          - The per page field must not be greater than 100.
                    request_id: 3f6c2a1e-8b4d-4f7a-9c2e-5d1b7a9e0c42
components:
  schemas:
    StatusComponent:
      type: object
      properties:
        id:
          type: integer
          description: Component id.
        label:
          type: string
        description:
          type:
            - string
            - 'null'
        category:
          type:
            - string
            - 'null'
          description: Group shown on the status page.
        icon:
          type:
            - string
            - 'null'
        status:
          type: string
          enum:
            - online
            - offline
            - maintenance
        is_online:
          type: boolean
        under_maintenance:
          type: boolean
        has_data:
          type: boolean
          description: '`false` until the first check ran.'
        response_time:
          type:
            - integer
            - 'null'
          description: Last response time in milliseconds.
        last_checked_at:
          type:
            - string
            - 'null'
          format: date-time
        uptime_percentage:
          type: number
          description: 90 day uptime in percent.
        history:
          type: array
          items:
            type: object
            properties:
              date:
                type: string
                format: date
              is_online:
                type: boolean
              downtime_minutes:
                type: integer
              maintenance_minutes:
                type: integer
              response_time:
                type:
                  - integer
                  - 'null'
              last_checked_at:
                type:
                  - string
                  - 'null'
                format: date-time
          description: >-
            Daily history for the last 90 days. Only with `include_history=1` or
            on the single component endpoint with that flag.
    Meta:
      type: object
      properties:
        request_id:
          type: string
          format: uuid
          description: Request id, also sent in the `X-Request-ID` response header.
      required:
        - request_id
    ValidationError:
      type: object
      properties:
        error:
          type: object
          properties:
            code:
              type: string
              enum:
                - validation_failed
              description: Always `validation_failed`.
            message:
              type: string
              description: Always `The request data is invalid.`
            details:
              type: object
              properties: {}
              description: >-
                Map of field name to a list of messages. Nested fields use dot
                notation, for example `ticket_ids.0`.
              additionalProperties:
                type: array
                items:
                  type: string
          required:
            - code
            - message
            - details
        request_id:
          type: string
          format: uuid
          description: Request id.
      description: Returned with HTTP 422 when the body or query string fails validation.
      required:
        - error
        - request_id
    Error:
      type: object
      properties:
        error:
          type: object
          properties:
            code:
              type: string
              description: >-
                Machine readable error code, for example `unauthorized`,
                `forbidden`, `not_found`, `invalid_service_state`.
            message:
              type: string
              description: Human readable explanation.
            details:
              type: object
              properties: {}
              description: Extra context. An empty object for most errors.
              additionalProperties: true
          required:
            - code
            - message
            - details
        request_id:
          type: string
          format: uuid
          description: >-
            Request id. Also returned in the `X-Request-ID` header. Send your
            own with `X-Request-ID` to correlate logs.
      description: Error envelope returned by every failed request.
      required:
        - error
        - request_id
  responses:
    Unauthorized:
      description: Missing, invalid or inactive API key.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          examples:
            missing:
              summary: No Authorization header
              value:
                error:
                  code: unauthorized
                  message: Bearer token required.
                  details: {}
                request_id: 9aca26ca-e06f-4725-8e4b-4385d6c03422
            invalid:
              summary: Unknown or inactive key
              value:
                error:
                  code: unauthorized
                  message: Invalid or inactive token.
                  details: {}
                request_id: 8802a669-6f06-453e-a1d8-0b81621167c3
    Forbidden:
      description: >-
        The key lacks the permission for this endpoint, or the request IP is not
        in the key allow list.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          examples:
            forbidden:
              summary: Missing permission
              value:
                error:
                  code: forbidden
                  message: Insufficient permissions for this action.
                  details: {}
                request_id: 6bf04242-ac61-44b9-9dbf-b63a114b54c8
            ip_not_allowed:
              summary: IP not allowed
              value:
                error:
                  code: ip_not_allowed
                  message: Access denied from this IP address.
                  details: {}
                request_id: 3f6c2a1e-8b4d-4f7a-9c2e-5d1b7a9e0c42
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: >-
        API key created in Admin, API. Send it as `Authorization: Bearer <key>`.
        Each key has its own permissions and optional IP allow list.

````

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