#Усыпить сейчас

POST /v1/infra/servers/:id/sleep-now

Немедленно усыпляет работающий BLACKHOLE-сервер: виртуальная машина останавливается у провайдера, статус меняется на sleeping, рабочая биллинг-транзакция финализируется и открывается сонная (тариф sleep ниже). Полезно для разовой экономии, когда вы знаете, что сервер не понадобится в ближайшие часы. Для автоматической остановки через N минут простоя используйте `PATCH /sleep`.

#Параметры

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

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

#Примеры

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

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

#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/sleep-now

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

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

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

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

#Поля ответа

Поле Тип Описание
success boolean true при успешном переходе в sleeping

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

JSON 
{ "success": true }

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

400 — сервер не в BLACKHOLE:

JSON 
{
  "success": false,
  "error": {
    "code": "BLACKHOLE_ONLY",
    "message": "Sleep is only available for BLACKHOLE servers"
  }
}

#Ошибки

HTTP Код Описание
400 BLACKHOLE_ONLY Сервер в режиме OPEN. Для OPEN-серверов используйте `/stop`
400 NOT_RUNNING Сервер не в статусе running (уже спит, в ошибке или создаётся)
401 MISSING_API_KEY Не передан заголовок X-Api-Key
401 INVALID_API_KEY Неверный или просроченный API-ключ
404 NOT_FOUND Сервер не существует или принадлежит другому API-ключу
409 CONFLICT Гонка состояний — статус сервера изменился во время операции
429 RATE_LIMIT_EXCEEDED Превышен общий лимит запросов платформы

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

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

  • На OPEN-сервере используйте `/stop`. Функционально для BLACKHOLE /sleep-now и /stop эквивалентны, но /sleep-now помечен как BH-специфический и для OPEN вернёт BLACKHOLE_ONLY.
  • Автоматическое пробуждение сохраняется. В отличие от административного блока (preventWake=true), ручной /sleep-now не ставит preventWake — сервер проснётся сам при обращении к HTTPS-субдомену или по вызову `/deploy`.
  • Атомарный переход. База обновляется одним updateMany с фильтром status='RUNNING' — гонки двух одновременных вызовов приводят ко второму CONFLICT, а не к двойному списанию.

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