> ## 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 ru/openapi/ru-api-v3-openapi.yaml GET /health
openapi: 3.1.0
info:
  title: ER:LC Россия API V3
  description: >-
    API ER:LC Россия: серверы, пользователи, 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: Управление API токенами интеграции и проверка активных подписок.
  - name: API Подписок
    description: Каталог планов, заказы FunPay, начисление бенефитов и активация подписок.
  - name: API Авторизации
    description: >-
      Вход через Discord и Roblox OAuth2, управление сессиями пользователя и
      связывание аккаунтов.
  - name: Реальное Время и Вебхуки
    description: >-
      WebSocket шлюз событий и обработчик входящих вебхуков PRC с
      криптографической подписью Ed25519.
  - name: API Управления - Ключи
    description: Выпуск, аудит, деактивация и разграничение прав API ключей.
  - name: API Управления - Ограничения
    description: >-
      Тонкая настройка разрешенных версий, эндпоинтов, действий (actions) и
      query-параметров.
  - name: API Управления - WebSocket Ключи
    description: Управление ключами доступа к WebSocket шлюзу и подписками на каналы.
  - name: API Управления - Вебхуки
    description: Регистрация, валидация доступности и мониторинг пользовательских вебхуков.
  - name: API Управления - Панель
    description: >-
      Управление пользователями, подписками, тарифами, ручной баланс и системная
      статистика.
  - name: API Состояния
    description: Мониторинг работоспособности сервиса, подключений к PostgreSQL и Redis.
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.