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

> Стан API. `status: degraded` з відповіддю 200 означає, що частина даних тимчасово недоступна; 503 — API не працює.



## OpenAPI

````yaml uk/openapi/uk-api-v3-openapi.yaml GET /health
openapi: 3.1.0
info:
  title: ER:LC Росія API V3
  description: >-
    API ER:LC Russia: сервери, користувачі, CDN, редиректи, підписки та ключі
    доступу.
  version: 3.0.0
servers:
  - url: https://api.erlcrussia.com/v3
    description: Основний сервер (com)
  - url: https://api.erlcrussia.xyz/v3
    description: Резервний сервер (xyz)
security: []
tags:
  - name: ER:LC Сервер
    description: Отримання статусу, онлайн, списків гравців та персоналу сервера ER:LC.
  - name: ER:LC Команди
    description: >-
      Відправлення та постановка в чергу команд внутрішньоігрового сервера (:h,
      :m, :kick, :ban та ін.).
  - name: Економіка
    description: >-
      Взаємодія з економічною системою (користувачі, бізнес, мафії, магазин,
      реклама).
  - name: API Статистики
    description: >-
      Високопродуктивне отримання статистики дискорд-серверів та ігрових
      серверів (онлайн, учасники, роботи).
  - name: API Верифікації
    description: Пошук та зіставлення Discord ID та Roblox ID акаунтів.
  - name: CDN Ассети
    description: >-
      Завантаження, керування, статистика та очищення кешу файлів об'єктного
      сховища MinIO/Edge CDN.
  - name: CDN Папки
    description: Ієрархічна структура та сортування папок медіатеки CDN.
  - name: API Покарань
    description: Управління балансом та історією транзакцій балів гравців.
  - name: API Передплат
    description: >-
      Каталог планів, замовлення FunPay, нарахування бенефітів та активація
      підписок.
  - name: API Авторизації
    description: >-
      Вхід через Discord та Roblox OAuth2, керування сесіями користувача та
      зв'язування акаунтів.
  - name: API Управління - WebSocket Ключі
    description: Керування ключами доступу до WebSocket шлюзу та підписками на канали.
  - name: API Управління - Вебхукі
    description: Реєстрація, валідація доступності та моніторинг власних вебхуків.
  - name: API Управління - Панель
    description: >-
      Управління користувачами, підписками, тарифами, ручний баланс та системна
      статистика.
  - name: API Стану
    description: Моніторинг працездатності сервісу, підключень до PostgreSQL та Redis.
  - name: AI Audio
  - name: AI Studio
  - name: API Адмінки - Сервера
  - name: API Ключів
  - name: API Управління - Сервери
  - name: API Управління - Токени
  - name: CDN
  - name: CDN V3
  - name: CDN Домени
  - name: Адміністрація E-Coins
  - name: Адміністрування AI
  - name: Користувальницькі Вебхуки
  - name: Особисті файли та бібліотека
  - name: Редиректи організацій V3
  - name: Рекламные кампании V3
paths:
  /health:
    get:
      tags:
        - API Стану
      summary: Стан API
      description: >-
        Стан API. `status: degraded` з відповіддю 200 означає, що частина даних
        тимчасово недоступна; 503 — API не працює.
      responses:
        '200':
          description: Сервіс повністю справний.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HealthResponse'
              examples:
                healthy:
                  summary: Сервіс справний
                  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: База даних або критичні послуги недоступні.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HealthResponse'
              examples:
                disconnected:
                  summary: Збій підключення до бази даних
                  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.