#Образы ОС провайдера

GET /v1/infra/providers/:providerId/images

Возвращает список образов операционной системы, на которых можно поднять сервер. Значение id используется как параметр image при создании сервера. Провайдер bitrix-cloud поддерживает только Ubuntu 24.04 LTS — образ из ответа регулярно обновляется до свежей сборки с патчами безопасности.

#Параметры

Параметр В Тип Обяз. Описание
providerId path string да ID провайдера из `GET /v1/infra/providers`, например bitrix-cloud

#Примеры

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

Terminal 
curl -H "X-Api-Key: YOUR_API_KEY" \
  https://vibecode.bitrix24.tech/v1/infra/providers/bitrix-cloud/images

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

Terminal 
curl -H "X-Api-Key: YOUR_APP_KEY" \
  -H "Authorization: Bearer USER_SESSION_TOKEN" \
  https://vibecode.bitrix24.tech/v1/infra/providers/bitrix-cloud/images

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

javascript 
const res = await fetch(
  'https://vibecode.bitrix24.tech/v1/infra/providers/bitrix-cloud/images',
  { headers: { 'X-Api-Key': 'YOUR_API_KEY' } }
)
const { data: images } = await res.json()
const defaultImage = images[0].id  // актуальная сборка Ubuntu 24.04 LTS

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

javascript 
const res = await fetch(
  'https://vibecode.bitrix24.tech/v1/infra/providers/bitrix-cloud/images',
  {
    headers: {
      'X-Api-Key': 'YOUR_APP_KEY',
      'Authorization': 'Bearer USER_SESSION_TOKEN',
    },
  }
)

#Поля ответа

Поле Тип Описание
success boolean Всегда true при успехе
data array Массив образов
data[].id string ID образа, передаётся как image при создании сервера. Меняется при обновлении сборки — всегда берите актуальный из ответа, не хардкодьте
data[].name string Имя образа для отображения пользователю
data[].family string Семейство образов (ubuntu-2404-lts)
data[].version string Версия сборки

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

JSON 
{
  "success": true,
  "data": [
    {
      "id": "fd83esfomhq25p2ono90",
      "name": "Ubuntu 24.04 lts v20260410040341",
      "family": "ubuntu-2404-lts",
      "version": "ubuntu.24.04.lts.v20260413"
    }
  ]
}

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

404 — неизвестный providerId:

JSON 
{
  "success": false,
  "error": {
    "code": "NO_CREDENTIALS",
    "message": "No credentials configured for provider nonexistent"
  }
}

#Ошибки

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

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

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

  • Не кешируйте id на клиенте. ID образа меняется при каждом обновлении сборки — запрашивайте свежий перед каждым созданием сервера.
  • Другие семейства ОС не поддерживаются. Cloud-init скрипты настройки туннеля и рантаймов рассчитаны именно на Ubuntu 24.04 LTS. Debian, CentOS и прочие дистрибутивы не работают, даже если их образы доступны в Yandex Cloud напрямую.
  • Ответ не пагинируется.

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