> ## 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 (public)

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

This is the public, keyless version. It only returns what an anonymous visitor can see on your site, is cached for 60 seconds (edits in the admin area show up at once) and allows 60 requests per minute per IP.

**Authentication:** none, no API key needed.

**Rate limit:** 60 requests per minute per IP.



## OpenAPI

````yaml /docs/modules-api.yaml get /public/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:
  /public/modules/status/components:
    get:
      tags:
        - Status (public)
      summary: List components (public)
      description: >-
        Every enabled monitored component with its current status and 90 day
        uptime. Host names and check targets are never exposed.


        This is the public, keyless version. It only returns what an anonymous
        visitor can see on your site, is cached for 60 seconds (edits in the
        admin area show up at once) and allows 60 requests per minute per IP.


        **Authentication:** none, no API key needed.


        **Rate limit:** 60 requests per minute per IP.
      operationId: listStatusComponentsPublic
      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
          headers:
            Cache-Control:
              description: '`public, max-age=60`.'
              schema:
                type: string
            X-Cache:
              description: '`HIT` when served from the 60 second cache, `MISS` otherwise.'
              schema:
                type: string
                enum:
                  - HIT
                  - MISS
            X-RateLimit-Limit:
              description: Requests allowed per minute.
              schema:
                type: integer
            X-RateLimit-Remaining:
              description: Requests left in the current minute.
              schema:
                type: integer
        '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
        '429':
          $ref: '#/components/responses/TooManyRequests'
      security: []
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:
    TooManyRequests:
      description: Rate limit reached. Wait `Retry-After` seconds.
      headers:
        Retry-After:
          description: Seconds until the limit resets.
          schema:
            type: integer
        X-RateLimit-Limit:
          description: Requests allowed per minute.
          schema:
            type: integer
        X-RateLimit-Remaining:
          description: Requests left in the current minute.
          schema:
            type: integer
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            error:
              code: too_many_requests
              message: >-
                Too many requests. Retry after the number of seconds in the
                Retry-After header.
              details: {}
            request_id: db4f5a74-f1c8-4554-a36b-7dced81670a8
  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.