API
REST API Dockhost позволяет управлять проектами и их ресурсами без использования веб-интерфейса. API подходит для автоматизации развёртывания, CI/CD и интеграции с внешними системами.
| Ресурс | Адрес |
|---|---|
| Базовый URL | https://api.dockhost.io/v1 |
| Swagger | https://api.dockhost.io/swagger |
| OpenAPI | https://api.dockhost.io/openapi.json |
Интерактивную документацию Swagger и спецификацию OpenAPI можно использовать для генерации клиентов на вашем языке программирования.
Аутентификация
Все методы API, кроме публичных, требуют токен. Токен создаётся в личном кабинете Dockhost
и передаётся в HTTP-заголовке Authorization:
Authorization: Bearer <DOCKHOST_API_TOKEN>
Пример запроса:
curl -X 'GET' \
'https://api.dockhost.io/v1/projects' \
-H 'Authorization: Bearer <DOCKHOST_API_TOKEN>'
Храните токен в секрете и не публикуйте его в открытых репозиториях Git.
Формат запросов и ответов
Тела запросов и ответов передаются в формате JSON. Для методов с телом запроса
используйте заголовок Content-Type: application/json.
Коды ответов
| Код | Описание |
|---|---|
| 200 OK | Успешное выполнение |
| 201 Created | Ресурс создан |
| 204 No Content | Успешное удаление (пустой ответ) |
| 400 Bad Request | Невалидные параметры или лимиты |
| 401 Unauthorized | Отсутствует или неверный токен |
| 404 Not Found | Ресурс не найден |
| 409 Conflict | Конфликт, например, имя уже занято |
| 408 Request Timeout | Превышено время выполнения команды |
Разделы API
- Проекты — управление проектами и статистикой
- Проекты / DNS — управление DNS-конфигурацией проекта
- Контейнеры — управление контейнерами, репликами, логами и консолью
- Домены — управление доменами проекта
- Домены / Сертификаты — получение SSL/TLS-сертификатов
- Порты и WAF — управление портами и IP-правилами
- Маршруты и WAF — управление маршрутами, файрволом и rate limiting
- Сервисы — управление сетевыми сервисами
- Реестры образов — управление реестрами Docker-образов
- Репозитории Git — управление репозиториями и сборками
- Репозитории Git / Пайплайны — управление пайплайнами сборки
- Файлы конфигурации — управление конфигурационными файлами
- Переменные окружения — управление переменными окружения
- Сетевые диски — управление дисками, FTP и SFTP-доступом
- Сетевые диски / Снапшоты — управление снимками дисков