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

# API health

> API state. `status: degraded` with a 200 response means some data is temporarily unavailable; 503 means the API is down.



## OpenAPI

````yaml en/openapi/en-api-v3-openapi.yaml GET /health
openapi: 3.1.0
info:
  title: ER:LC Russia API V3
  description: >-
    ER:LC Russia API for servers, users, CDN, redirects, subscriptions, and
    access keys.
  version: 3.0.0
servers:
  - url: https://api.erlcrussia.com/v3
    description: Production server (com)
  - url: https://api.erlcrussia.xyz/v3
    description: Backup server (xyz)
security: []
tags:
  - name: ER:LC Server
    description: Obtaining status, online, lists of players and staff of the ER:LC server.
  - name: ER:LC Teams
    description: Sending and queuing in-game server commands (:h, :m, :kick, :ban, etc.).
  - name: Economics
    description: >-
      Interaction with the economic system (users, businesses, mafias, stores,
      advertising).
  - name: Statistics API
    description: >-
      High-performance obtaining statistics of discord servers and game servers
      (online, participants, bots).
  - name: Verification API
    description: Search and comparison of Discord ID and Roblox ID accounts.
  - name: CDN Assets
    description: >-
      Load, manage, statistic and clear MinIO/Edge CDN object storage file
      cache.
  - name: CDN Folders
    description: Hierarchical structure and sorting of CDN media library folders.
  - name: Punishment API
    description: Manage the balance and transaction history of players' points.
  - name: Subscriptions API
    description: >-
      Catalog of plans, FunPay orders, accrual of benefits and activation of
      subscriptions.
  - name: Authorization API
    description: >-
      Login via Discord and Roblox OAuth2, manage user sessions and link
      accounts.
  - name: Management API - WebSocket Keys
    description: Managing access keys to the WebSocket gateway and channel subscriptions.
  - name: Management API - Webhooks
    description: Registration, accessibility validation and monitoring of custom webhooks.
  - name: Control API - Panel
    description: >-
      Management of users, subscriptions, tariffs, manual balance and system
      statistics.
  - name: State API
    description: >-
      Monitoring the performance of the service, connections to PostgreSQL and
      Redis.
  - name: AI Audio
  - name: AI Studio
  - name: AI administration
  - name: API Keys
  - name: Admin API - Servers
  - name: Administration of E-Coins
  - name: CDN
  - name: CDN Domains
  - name: CDN V3
  - name: Custom Webhooks
  - name: Management API - Servers
  - name: Management API - Tokens
  - name: Organization redirects V3
  - name: Private files and library
  - name: Рекламные кампании V3
paths:
  /health:
    get:
      tags:
        - State API
      summary: API health
      description: >-
        API state. `status: degraded` with a 200 response means some data is
        temporarily unavailable; 503 means the API is down.
      responses:
        '200':
          description: The service is completely fine.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HealthResponse'
              examples:
                healthy:
                  summary: Service is correct
                  value:
                    status: ok
                    version: v3
                    uptime: 1h59m5s
                    timestamp: '2026-09-14T12:44:52Z'
                    services:
                      database:
                        status: ok
                        ping: 3.19ms
                      redis:
                        status: ok
                        ping: 10.72ms
                      erlc_servers:
                        status: ok
                        servers:
                          - name: ER:LC Сервер 1
                            server_id: srv_8f9a2b1c4e
                            title: Moscow RolePlay I RU
                            status: ok
                            cache: ok
                            current_players: 1
                            max_players: 50
                            ttl: 9m50s
                            bans_cached: true
                          - name: ER:LC Сервер 2
                            server_id: srv_3d5e7f9a1b
                            title: Moscow RolePlay I Global
                            status: ok
                            cache: ok
                            current_players: 0
                            max_players: 50
                            ttl: 9m50s
                            bans_cached: true
        '503':
          description: The database or critical services are unavailable.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HealthResponse'
              examples:
                disconnected:
                  summary: Database connection failure
                  value:
                    status: degraded
                    version: v3
                    uptime: 1h59m5s
                    timestamp: '2026-09-14T12:44:52Z'
                    services:
                      database:
                        status: disconnected
                      redis:
                        status: ok
                        ping: 10.72ms
                      erlc_servers:
                        status: ok
                        servers:
                          - name: ER:LC Сервер 1
                            server_id: srv_8f9a2b1c4e
                            title: Moscow RolePlay I RU
                            status: ok
                            cache: ok
                            current_players: 1
                            max_players: 50
                            ttl: 9m50s
                            bans_cached: true
                          - name: ER:LC Сервер 2
                            server_id: srv_3d5e7f9a1b
                            title: Moscow RolePlay I Global
                            status: ok
                            cache: ok
                            current_players: 0
                            max_players: 50
                            ttl: 9m50s
      security: []
components:
  schemas:
    HealthResponse:
      type: object
      properties:
        status:
          type: string
          example: ok
        version:
          type: string
          example: v3
        uptime:
          type: string
          example: 1h59m5s
        timestamp:
          type: string
          format: date-time
          example: '2026-09-14T12:44:52Z'
        services:
          type: object
          properties:
            database:
              type: object
              properties:
                status:
                  type: string
                  example: ok
                ping:
                  type: string
                  example: 3.19ms
            redis:
              type: object
              properties:
                status:
                  type: string
                  example: ok
                ping:
                  type: string
                  example: 10.72ms
            erlc_servers:
              type: object
              properties:
                status:
                  type: string
                  example: ok
                servers:
                  type: array
                  items:
                    type: object
                    properties:
                      name:
                        type: string
                        example: ER:LC Сервер 1
                      server_id:
                        type: string
                        example: srv_8f9a2b1c4e
                      title:
                        type: string
                        example: Moscow RolePlay I RU
                      status:
                        type: string
                        example: ok
                      cache:
                        type: string
                        example: ok
                      current_players:
                        type: integer
                        example: 1
                      max_players:
                        type: integer
                        example: 50
                      ttl:
                        type: string
                        example: 9m50s
                      bans_cached:
                        type: boolean
                        example: true

````

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