Serverspace Public API — это открытый интерфейс для управления облачными сервисами и инфраструктурой Serverspace. С помощью Serverspace Public API можно полностью автоматизировать управление облачными сервисами, избавившись от необходимости выполнять каждое действие вручную через веб-панель. API позволяет интегрировать управление серверами, сетями и проектами прямо в ваши скрипты, приложения или CI/CD-процессы. Это особенно удобно для разработчиков, DevOps-инженеров и системных администраторов, которые хотят ускорить работу, снизить риск ошибок и обеспечить единообразие при создании и настройке ресурсов в облаке. С помощью API вы можете создавать и удалять серверы, отслеживать баланс проекта, управлять сетью и выполнять многие другие задачи автоматически, экономя время и ресурсы.
Список API-ключей
API-ключи позволяют вашему приложению получать доступ к функциям проекта. Каждый ключ — это уникальный идентификатор, который определяет ваши права и используется для авторизации запросов.
Авторизация
Чтобы начать работу с Public API, создайте API-ключ в панели управления Serverspace. Затем передавайте его в каждом запросе через заголовок X-API-KEY.
Пример заголовка в cURL:
-H "X-API-KEY: lmGwbvllpIqIrKROOCLgE5Z941MKP5EYfbkgwtqJZGigfXUTpuYRpNQkCqShmm6r"Все вызовы должны выполняться по HTTPS. Базовый эндпоинт API:
https://api.serverspace.io/Практическое применение API
Получение данных о вашем проекте
Для того чтобы узнать текущие параметры и состояние проекта, отправьте запрос к API. Ниже приведен пример того, как можно получить информацию о проекте с помощью утилиты cURL:
curl -X GET \
https://api.serverspace.io/api/v1/project \
-H 'content-type: application/json' \
-H 'x-api-key: lmGwbvllpIqIrKROOCLgE5Z941MKP5EYfbkgwtqJZGigfXUTpuYRpNQkCqShmm6r'Ответ:
{
"project": {
"balance": 400.07,
"created": "2019-04-08T10:35:53.7021047Z",
"currency": "EUR",
"id": 1,
"state": "Active"
}
}Создание сервера
Настроим сервер в Амстердаме с параметрами:
Debian 10.7, 1 CPU, 1 ГБ RAM, диск 25 ГБ, 50 Мбит/с, имя api-example.
curl -X POST \
https://api.serverspace.io/api/v1/servers \
-H 'content-type: application/json' \
-H 'x-api-key: lmGwbvllpIqIrKROOCLgE5Z941MKP5EYfbkgwtqJZGigfXUTpuYRpNQkCqShmm6r' \
-d '{
"location_id": "am2",
"image_id": "Debian-10.7-X64",
"cpu": 1,
"ram_mb": 1024,
"volumes": [
{
"name": "boot",
"size_mb": 25600
}
],
"networks": [
{
"bandwidth_mbps": 50
}
],
"name": "api-example"
}'Ответ с ID задачи:
{
"task_id" : "lt1507097"
}
FAQ (Частые вопросы)
- Нужно ли обновлять API-ключи?
Да, если вы считаете, что ключ мог быть скомпрометирован, удалите его и создайте новый. Срока действия по умолчанию у ключей нет. - Можно ли ограничить действия ключа?
Да. При создании API-ключа можно выбрать нужные права доступа: чтение, создание ресурсов, биллинг и т. д. - API работает синхронно или асинхронно?
Большинство операций выполняются асинхронно. API возвращает task_id, по которому можно отслеживать прогресс. - Где посмотреть документацию?
На официальной странице Public API — там перечислены все ресурсы, параметры и схемы данных.
Шпаргалка по Serverspace API
| Команда / Параметр | Описание |
|---|---|
| Эндпоинт API | https://api.serverspace.io/ |
| Заголовок авторизации | X-API-KEY: <ваш ключ> |
| Получить информацию о проекте | GET /api/v1/project |
| Создать сервер | POST /api/v1/servers |
| Проверить статус задачи | GET /api/v1/tasks/<task_id> |
| location_id | am2, ny1, il1 и другие регионы |
| image_id | Debian-10.7-X64, Ubuntu-22.04-X64 и др. |
| cpu | Количество vCPU |
| ram_mb | Оперативная память в МБ |
| volumes[] | Диски сервера |
| networks[] | Сеть и пропускная способность |
Автоматизация и управление облаком с Serverspace API
Использование Serverspace API позволяет безопасно и эффективно управлять всеми облачными сервисами напрямую через HTTP-запросы, без необходимости заходить в веб-панель. С помощью API вы можете автоматизировать создание, настройку и мониторинг серверов, управлять сетевыми ресурсами и контролировать состояние проектов, интегрируя эти операции в ваши скрипты, приложения или CI/CD-процессы. Обмен данными происходит в удобном формате JSON, а архитектура API построена на REST, что обеспечивает совместимость с большинством современных инструментов и библиотек. API поддерживает ключевые методы GET, POST, PUT и DELETE, позволяя гибко управлять ресурсами и легко интегрироваться в существующие рабочие процессы.
Не храните API-ключи в открытом виде — используйте переменные окружения или защищённые хранилища для скриптов. Перед массовым созданием серверов рекомендуется тестировать запросы на отдельном проекте с минимальными ресурсами, чтобы избежать непредвиденных расходов. Для отслеживания прогресса операций сохраняйте task_id и регулярно проверяйте статус задачи через GET /api/v1/tasks/<task_id>.
Полная документация и практические примеры помогут быстро освоить работу с API, а автоматизация рутинных операций снижает риск ошибок и ускоряет процессы управления инфраструктурой. Используя Serverspace API, вы получаете полный контроль над облаком: ваши проекты становятся более управляемыми, гибкими и интегрируемыми в любые процессы разработки и эксплуатации, а повторяющиеся задачи можно легко автоматизировать для экономии времени и ресурсов.
