Создать копию базы

POST /v1/infra/servers/:id/db/backups

Ставит в очередь ручную копию SQLite-файла приложения. Копия создаётся в фоновом режиме, приложение во время копирования продолжает работать.

Параметры

Поля запроса (body)

Тело необязательно: без тела и с пустым объектом {} копируется файл по умолчанию. С заголовком Content-Type: application/json тело не может быть пустым — передайте {}. Других полей тело не принимает, размер тела — до 4 КиБ.

Примеры

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

curl -X POST "https://vibecode.bitrix24.tech/v1/infra/servers/APP_ID/db/backups" \
  -H "X-Api-Key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'

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

curl -X POST "https://vibecode.bitrix24.tech/v1/infra/servers/APP_ID/db/backups" \
  -H "X-Api-Key: YOUR_APP_KEY" \
  -H "Authorization: Bearer USER_SESSION_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{}'

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

const res = await fetch(
  `https://vibecode.bitrix24.tech/v1/infra/servers/${appId}/db/backups`,
  {
    method: 'POST',
    headers: { 'X-Api-Key': 'YOUR_API_KEY', 'Content-Type': 'application/json' },
    body: JSON.stringify({}),
  }
)
const { success, data, error } = await res.json()
if (!success) throw new Error(`${error.code}: ${error.message}`)
console.log('Копия в очереди:', data.backupId)

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

const res = await fetch(
  `https://vibecode.bitrix24.tech/v1/infra/servers/${appId}/db/backups`,
  {
    method: 'POST',
    headers: {
      'X-Api-Key': 'YOUR_APP_KEY',
      'Authorization': 'Bearer USER_SESSION_TOKEN',
      'Content-Type': 'application/json',
    },
    body: JSON.stringify({}),
  }
)
const { success, data, error } = await res.json()
if (!success) throw new Error(`${error.code}: ${error.message}`)

Поля ответа

HTTP-статус успешного ответа — 202 Accepted: копия принята в очередь, но ещё не создана.

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

{
  "success": true,
  "data": {
    "backupId": "9e4d2c1b-6a3f-4b8e-a7d5-0c1f2e3d4b5a",
    "status": "QUEUED"
  }
}

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

409 — повторный запрос сразу после создания копии, предыдущая копия этого приложения ещё не завершена:

{
  "success": false,
  "error": {
    "code": "APP_DB_BUSY",
    "message": "The database is busy with a live write, retry shortly",
    "details": {
      "source": "sqlite",
      "retryable": true,
      "retryAfterSeconds": 1
    }
  }
}

Ошибки

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

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

Готовность копии. Ответ 202 не означает, что копия создана. Опрашивайте GET /db/backups и ищите элемент с id, равным backupId: копия готова при status равном COMPLETED, а при FAILED причину называет errorCode. На тестовом приложении с копией размером 937 байт копия дошла от QUEUED до COMPLETED за 1 мин 40 с.

Одна копия за раз. Пока предыдущая копия приложения не завершена, повторы запроса через details.retryAfterSeconds получают тот же 409 APP_DB_BUSY. Текст message причину не называет: при details.source равном sqlite он говорит о записи в базу, даже когда базу занимает незавершённая копия. Вместо частых повторов дождитесь завершения копии по списку копий.

Где хранятся копии, сколько они живут и как оплачиваются — Копии и их хранение.

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

• Получить список копий базы
• Восстановить базу из копии
• Получить сведения о базе
• База данных приложения