MKSmile API

Infrastructure API · concept v1.4.2

Backup Sync API PREVIEW

Черновик программного интерфейса для задач резервного копирования и статусов jobs: JSON over HTTPS, Bearer-токены, OpenAPI 3.0. Интерактивная консоль — для ознакомления со схемой, не для продакшен-нагрузки.

Interactive docs (Swagger) Download OpenAPI

Кнопки Docs / Open Console открывают Swagger UI на этом же домене (без внешних CDN).

# Публичный health (без токена)
curl -s https://api.mksmile.ru/v1/health

# Защищённые методы в preview отвечают 401 без Bearer
curl -s -H "Authorization: Bearer $MKS_TOKEN" \
  https://api.mksmile.ru/v1/backups?limit=20

Versioned draft

Префикс /v1, RFC 7807 problem+json, ISO-8601. Схема может эволюционировать на этапе concept.

Bearer (planned)

Модель scoped API tokens для будущих интеграций. В preview без токена защищённые пути возвращают 401.

Probe-friendly

Публичный /v1/health для проверки доступности. Swagger Try it out работает для health из коробки.

Draft endpoints

MethodPathDescription
GET/v1/healthLiveness (public in preview)
GET/v1/backupsList snapshots (auth required)
POST/v1/backupsEnqueue backup (auth required)
GET/v1/jobs/{id}Job status (auth required)
GET/v1/auth/tokenToken introspection (auth required)