#Остановить сервер

POST /v1/infra/servers/:id/stop

Штатная остановка работающего сервера. Виртуальная машина останавливается у провайдера, статус меняется на sleeping, открытая биллинг-транзакция по рабочему периоду закрывается, открывается транзакция по сонному периоду (тариф sleep существенно ниже). Работает для любого режима — и BLACKHOLE, и OPEN. Сервер можно снова запустить через `POST /start` или разбудить автоматически обращением к субдомену.

#Параметры

Параметр В Тип Обяз. Описание
id path string (UUID) да ID сервера

Тело запроса пустое.

#Примеры

#curl — личный ключ

Terminal 
curl -X POST -H "X-Api-Key: YOUR_API_KEY" \
  https://vibecode.bitrix24.tech/v1/infra/servers/SERVER_ID/stop

#curl — OAuth-приложение

Terminal 
curl -X POST -H "X-Api-Key: YOUR_APP_KEY" \
  -H "Authorization: Bearer USER_SESSION_TOKEN" \
  https://vibecode.bitrix24.tech/v1/infra/servers/SERVER_ID/stop

#JavaScript — личный ключ

javascript 
await fetch(
  `https://vibecode.bitrix24.tech/v1/infra/servers/${serverId}/stop`,
  { method: 'POST', headers: { 'X-Api-Key': 'YOUR_API_KEY' } }
)

#JavaScript — OAuth-приложение

javascript 
await fetch(
  `https://vibecode.bitrix24.tech/v1/infra/servers/${serverId}/stop`,
  {
    method: 'POST',
    headers: {
      'X-Api-Key': 'YOUR_APP_KEY',
      'Authorization': 'Bearer USER_SESSION_TOKEN',
    },
  }
)

#Поля ответа

Поле Тип Описание
success boolean true при успешной остановке

#Пример ответа

JSON 
{ "success": true }

#Пример ответа при ошибке

404 — сервер не в статусе running:

JSON 
{
  "success": false,
  "error": {
    "code": "NOT_FOUND",
    "message": "Running server not found"
  }
}

#Ошибки

HTTP Код Описание
401 MISSING_API_KEY Не передан заголовок X-Api-Key
401 INVALID_API_KEY Неверный или просроченный API-ключ
404 NOT_FOUND Сервер не в статусе running, удалён или принадлежит другому API-ключу
429 RATE_LIMIT_EXCEEDED Превышен общий лимит запросов платформы
502 PROVIDER_ERROR Облачный провайдер вернул ошибку при остановке

Полный список общих ошибок API — Ошибки.

#Известные особенности

  • Почему sleeping, а не stopped. Это терминология Infrastructure API: остановленный сервер называется «спящим», потому что биллинг для него идёт по отдельному тарифу sleepPriceMonthly (см. тарифы провайдера) — ниже, чем рабочий. Значение stopped в v1-ответах не встречается.
  • /stop сбрасывает preventWake (автоматический флаг, блокирующий пробуждение) — после остановки сервер снова можно пробудить автоматически обращением к субдомену или через `/wake`.
  • Для BLACKHOLE есть альтернатива — `/sleep-now`. Функционально результат идентичный. /sleep-now используется из UI-кнопки «Усыпить» и явно помечен как BH-специфический; /stop — универсальный для любого режима.

#Смотрите также