КЛИЕНТСКИЙ API · V1 БЕТА
REST API для
VPS и выделенных серверов
Управляйте серверами из кода: заказывайте и удаляйте почасовые VPS, выполняйте действия с питанием и переустановку, сохраняйте и разворачивайте собственные образы и оплачивайте счета с баланса.
Клиентский API X-ZoneServers (v1, публичная бета) предоставляет 92 операции по HTTPS со спецификацией OpenAPI 3.0, API-ключами с ограниченным набором прав и лимитом по умолчанию 1 000 запросов в час на ключ. Доступ к нему входит в каждый аккаунт без дополнительной платы.
92 операции API1 000 запросов в час на ключ
Первый запрос
Создайте ключ в клиентской панели в разделе Profile → API Keys, а затем спросите у API, кто вы.
curl https://my.x-zoneservers.com/api/v1/ \
-H "Authorization: Bearer $XZ_API_KEY"
{ "success": true,
"data": {
"version": "1",
"key": { "scopes": ["read", "services"] },
"rate_limit": { "limit": 1000, "remaining": 999 }
} }01Возможности
Что можно автоматизировать
API охватывает весь жизненный цикл сервера — от заказа до счёта — с теми же правами, что и в клиентской панели.
Развёртывание и удаление
Заказывайте VPS с почасовой или помесячной оплатой, передавайте user-data для cloud-init и SSH-ключи для первой загрузки и удаляйте сервер, когда задача выполнена. Почасовая оплата прекращается в момент удаления сервера.
Питание, переустановка и статистика
Запускайте, останавливайте, перезагружайте и переустанавливайте свои VPS, сбрасывайте пароли root и получайте статистику использования и трафика в своих скриптах мониторинга.
Собственные образы
Сохраните VPS как образ (до 3 на аккаунт) или зарегистрируйте собственный образ qcow2 или raw (с проверкой по SHA-256) и разворачивайте из него новые серверы.
Оплата и потребление
Узнавайте баланс и почасовые начисления за текущий месяц, получайте список счетов и проформ и оплачивайте их с баланса — удобно для дашбордов расходов и оповещений о бюджете.
Дополнения и повышение тарифа
Покупайте дополнения к существующей услуге, например дополнительные IP-адреса, или переводите её на более крупный тариф, не открывая панель.
Проекты и ключи с ограниченным доступом
Группируйте серверы по проектам и выпускайте ключи, привязанные к одному проекту, чтобы ключ от staging-окружения никогда не видел продакшен и не мог его затронуть.
02Как это работает
Пример: почасовой VPS для одной задачи CI
Создайте чистую сборочную машину, запустите конвейер, удалите её — и заплатите за те часы, что она существовала.
Почасовые услуги оплачиваются с баланса аккаунта, а не по выставленному счёту, поэтому держите на аккаунте положительный баланс. Отправляйте заголовок Idempotency-Key с каждым заказом: тогда запрос, завершившийся по таймауту, можно повторить, не создав второй сервер.
1. Выберите тариф: получите список продуктов с почасовыми и месячными ценами.
curl https://my.x-zoneservers.com/api/v1/products \
-H "Authorization: Bearer $XZ_API_KEY"2. Закажите его с почасовой оплатой, скриптом первой загрузки и вашим SSH-ключом.
curl -X POST https://my.x-zoneservers.com/api/v1/orders \
-H "Authorization: Bearer $XZ_API_KEY" \
-H "Idempotency-Key: ci-run-4812" \
-H "Content-Type: application/json" \
-d '{"productId": "<plan-id>", "billingCycle": "hourly",
"hostname": "ci-4812.example.com", "location": "<location>",
"configOptions": {"os_image_id": "<image-id>",
"ssh_keys": ["ssh-ed25519 AAAA... ci@runner"],
"user_data": "#!/bin/sh\n/opt/ci/run-pipeline.sh"}}'3. Когда задача завершится, удалите сервер. Оплата прекращается сразу.
curl -X DELETE https://my.x-zoneservers.com/api/v1/vps/<vps-id> \
-H "Authorization: Bearer $XZ_API_KEY" \
-H "Content-Type: application/json" \
-d '{"immediate": true}'03API
Создан для скриптов и ИИ-агентов
Когда кнопки нажимает программа, а не человек, предсказуемое поведение важнее количества эндпоинтов.
Ключи с ограниченными правами
Каждый ключ получает только те права, которые вы выдали, — read, services, orders, billing, destructive, — а также необязательный список разрешённых IP-адресов и срок действия.
Опубликованные лимиты запросов
По умолчанию 1 000 запросов в час на ключ; состояние лимита передаётся в заголовках X-RateLimit, а для действий с питанием и переустановки действуют короткие паузы на каждый сервер.
Безопасные повторы
Заказы принимают Idempotency-Key, а каждый отказ возвращает машиночитаемый код ошибки, чтобы автоматика могла отличить сбой, который можно повторить, от настоящего.
Машиночитаемая документация
Спецификация OpenAPI 3.0 для генераторов клиентов и руководство в простом Markdown, которое ассистенты для программирования и ИИ-агенты могут читать напрямую.
04Похожее
Продаёте серверы своим клиентам?
Этот клиентский API автоматизирует ваш собственный аккаунт. Чтобы перепродавать услуги под своим брендом, вступите в реселлерскую программу и используйте вместо него API для реселлеров: оптовые цены с градацией по объёму, запросы с подписью HMAC, вебхуки, ключи, привязанные к клиентам, и ссылки на консоль, которые ваши клиенты открывают без аккаунта у нас.
05Вопросы
FAQ по API
Частые вопросы об автоматизации X-ZoneServers.
Есть ли у X-ZoneServers API?
Да. Клиентский API (v1) — это REST API по HTTPS по адресу https://my.x-zoneservers.com/api/v1 с 92 операциями, которые охватывают VPS, выделенные серверы, заказы, дополнения, повышение тарифа, счета, SSH-ключи и собственные образы. Он находится в публичной бете: достаточно стабилен, чтобы строить на нём решения, но эндпоинты и формат ответов ещё могут меняться.
Доступ к API бесплатный?
Да. Доступ к API входит в каждый аккаунт без дополнительной платы; вы платите только за заказанные серверы и дополнения — по тем же ценам, что на сайте и в клиентской панели.
Можно ли создавать и удалять почасовые VPS через API?
Да. Оформите заказ с почасовым расчётным периодом, при желании с user-data для cloud-init и SSH-ключами, а затем удалите VPS, когда он станет не нужен. Почасовые услуги оплачиваются с баланса аккаунта, и начисления прекращаются сразу после удаления.
Работает ли API с выделенными серверами?
Частично. Для выделенных серверов API охватывает заказ, дополнения, счета и сведения об услуге. Управление питанием, переустановка ОС и сброс паролей для выделенных серверов недоступны ни через API, ни через клиентскую панель.
Как пройти аутентификацию?
Создайте API-ключ в клиентской панели в разделе Profile → API Keys и передавайте его как Bearer-токен. Права задаются при создании ключа; при желании его можно ограничить определёнными IP-адресами или задать срок действия. Ключ показывается один раз, и его можно отозвать в панели в любой момент.
Есть ли спецификация OpenAPI или Swagger?
Да. Полная спецификация OpenAPI 3.0 опубликована по адресу https://my.x-zoneservers.com/api/v1/openapi.json рядом с отрендеренной документацией и руководством по использованию в формате Markdown.
Начать
Создайте свой первый API-ключ
Войдите в клиентскую панель, откройте Profile → API Keys и сделайте первый запрос меньше чем за минуту. Вопросы по API попадают напрямую к тем, кто разрабатывает платформу.