Карточка приложения

GET /v1/applications/:id

Возвращает одно приложение портала со сводкой по серверу, сохранённым исходникам и идущей операции. Карточка доступна владельцу и тому, кому приложение открыли — лично или через политику сервера. Администрирование портала здесь роли не играет: администратор, который приложением не владеет и доступа не получал, получает 403 FORBIDDEN наравне с любым другим зрителем.

Параметры

Примеры

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

curl -H "X-Api-Key: YOUR_API_KEY" \
  https://vibecode.bitrix24.tech/v1/applications/cmsw806qi0000tdskiw2aegii

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

curl -H "X-Api-Key: YOUR_APP_KEY" \
  -H "Authorization: Bearer USER_SESSION_TOKEN" \
  https://vibecode.bitrix24.tech/v1/applications/cmsw806qi0000tdskiw2aegii

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

const id = 'cmsw806qi0000tdskiw2aegii'
const res = await fetch(`https://vibecode.bitrix24.tech/v1/applications/${id}`, {
  headers: { 'X-Api-Key': 'YOUR_API_KEY' },
})
const { data: application } = await res.json()

console.log(application.name, application.server?.status ?? 'сервера нет')
if (application.sources.hasVersions) {
  console.log('Последняя версия:', application.sources.latestVersionId)
}

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

const id = 'cmsw806qi0000tdskiw2aegii'
const res = await fetch(`https://vibecode.bitrix24.tech/v1/applications/${id}`, {
  headers: {
    'X-Api-Key': 'YOUR_APP_KEY',
    'Authorization': 'Bearer USER_SESSION_TOKEN',
  },
})
const { data: application } = await res.json()

Поля ответа

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

{
  "success": true,
  "data": {
    "id": "cmsw806qi0000tdskiw2aegii",
    "name": "Отчёт по сделкам",
    "description": "Сводка по воронке за период",
    "type": "PERSONAL",
    "iconUrl": null,
    "createdAt": "2026-08-16T19:51:18.810Z",
    "updatedAt": "2026-08-16T19:51:18.810Z",
    "viewerState": "owner",
    "pinned": false,
    "author": { "name": "Автор приложений" },
    "isEmbedded": false,
    "openUrl": "https://app-05b67cf7.vibecode.bitrix24.tech",
    "openTarget": "app",
    "server": {
      "id": "5cbb50f9-f95f-4ddf-ba3b-b771209cb6fb",
      "status": "RUNNING",
      "url": "https://app-05b67cf7.vibecode.bitrix24.tech",
      "kind": "STANDALONE",
      "reachable": true,
      "lastDeployedAt": "2026-08-16T19:50:41.302Z"
    },
    "sources": {
      "hasVersions": true,
      "latestVersionId": "v2",
      "latestSavedAt": "2026-08-16T19:41:18.818Z"
    },
    "activeOperation": {
      "kind": "deploy",
      "status": "running",
      "step": "build",
      "startedAt": "2026-08-16T19:50:33.822Z"
    }
  }
}

Приложение без сервера отдаёт server: null, пустую сводку sources и activeOperation: null. Открывать его негде, поэтому openUrl и openTarget тоже приходят null — приложение из примера встроено в Битрикс24, и это ровно тот случай:

{
  "success": true,
  "data": {
    "id": "cmsw806qp0001tdskzf6mitka",
    "name": "Черновик без сервера",
    "description": null,
    "type": "PERSONAL",
    "iconUrl": null,
    "createdAt": "2026-08-16T19:51:18.817Z",
    "updatedAt": "2026-08-16T19:51:18.817Z",
    "viewerState": "owner",
    "pinned": false,
    "author": { "name": "Автор приложений" },
    "isEmbedded": true,
    "openUrl": null,
    "openTarget": null,
    "server": null,
    "sources": { "hasVersions": false, "latestVersionId": null, "latestSavedAt": null },
    "activeOperation": null
  }
}

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

404 — приложения с таким идентификатором на портале нет:

{
  "success": false,
  "error": {
    "code": "APPLICATION_NOT_FOUND",
    "message": "Application not found"
  }
}

Ошибки

Текст error.message всегда английский и предназначен для журналов, а не для показа человеку: тексты для интерфейса стройте по error.code. Полный список общих ошибок API — Ошибки.

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

• Карточка открыта не только владельцу. Приложение, которым с вами поделились, читается по прямой ссылке — отвечают состояния owner, shared и usable. Зритель без доступа получает 403 FORBIDDEN, поэтому значение requestable в карточке не встречается.
• У встроенного приложения открывать негде, и оба поля приходят null. Адреса, по которому встроенное приложение открывают внутри портала, платформа пока не знает. Пустое место здесь штатный ответ, а не сбой: выдуманная ссылка увела бы человека не туда, а отличить это от рабочего перехода он бы не смог.
• Адрес сервера в openUrl не подставляется, и подставлять его самостоятельно нельзя. Поле server.url у встроенного приложения приходит как обычно, но местом открытия не является: по нему отдаётся страница входа шлюза с кодом 200, то есть переход выглядит удачным, не будучи им. Клиент, который «починит» пустой openUrl подстановкой server.url, получит именно этот тихий отказ.
• openUrl не гасится недоступностью сервера. Адрес приходит и при server.reachable: false. Погашенную кнопку человек диагностировать не может, а показанный отказ — может.
• Пустую пару открытия различает isEmbedded, и только он. «Встроено, открывается внутри Битрикс24» и «ещё не опубликовано» приходят с одинаковыми openUrl: null и openTarget: null, а показать человеку нужно разное. Выводить встройку из наличия сервера НЕЛЬЗЯ: встроенное приложение без своего сервера — обычное состояние (встроили раньше, чем выложили код), и наоборот, у встроенного приложения с сервером server.url приходит как обычно, но местом открытия не является.
• У приложения в галактике вторая половина reachable — про хост, а не про контейнер. У server.kind: "GALAXY_APP" связность держит общий хост галактики; у самого контейнера своего туннеля нет по устройству. Поэтому true здесь означает сразу три вещи: контейнер работает, хост работает, туннель хоста поднят — признак включает status === "RUNNING" и без него истинным не бывает. Практическое следствие в другую сторону: только что созданный контейнер, ещё не дошедший до RUNNING (а доходит он до него лишь после первой загрузки исходников), приедет с reachable: false при совершенно живом хосте. Это «контейнер пока не поднялся», а не «хост недоступен», и по одному признаку два случая не различить — смотрите status. У STANDALONE такого расщепления нет: там оба факта про одну машину.
• lastDeployedAt заполняется вперёд, а не назад. Отметку ставит сама выкладка, в тот же момент, когда фиксирует успех, поэтому она не может разойтись с исходом: провалившаяся выкладка её не двигает. Но и истории у поля нет: у серверов, существовавших до 18.08.2026, оно пустое до первой следующей выкладки. Восстановить историю было можно только из журнала операций, а он покрывает лишь один из трёх путей выкладки — тогда дата была бы у приложений на выделенной машине и отсутствовала у приложений в галактике, и эта пустота читалась бы как «галактические приложения мертвы». Ровное «выкладок с тех пор не было» честнее. Поэтому null в первые недели — норма, а не признак заброшенного приложения.
• Снесённый сервер приходит как server: null, а не отдельным статусом. Значений вроде deleted, terminated, destroyed или archived в server.status вы не увидите — но по разным причинам, и это стоит различать: трёх последних в платформе нет вовсе, а состояние «снесён» существует и просто не публикуется этим разделом. Как только сервер снесён, карточка отдаёт server: null целиком, вместе с openUrl: null. Если вы нормализуете статусы, пришедшие из GET /v1/infra/servers, учтите, что там набор другой — тот раздел отдаёт статус строчным и по параметру includeDeleted показывает удалённые серверы. У витрины такого параметра нет.
• Приложение чужого портала неотличимо от несуществующего. На идентификатор из другого портала приходит 404 APPLICATION_NOT_FOUND, а не 403: раздел не подтверждает даже факт существования такой записи.
• Сводка исходников и идущая операция приходят только управляющему. Зрителю, которому приложение просто открыли, sources приходит пустым, а activeOperation — null, и форма ответа при этом не меняется. Поэтому пустая сводка сама по себе не значит «версий нет»: причин у неё три, и снаружи они выглядят одинаково — у приложения нет сервера, версий действительно нет, или приложение чужое и эти данные вам не отдаются. Клиент, который по пустому sources рисует «кода нет», ошибётся на каждом чужом приложении.
• activeOperation: null не означает «с приложением ничего не происходит». Признак честен только для операций с сохранённой записью — это выкладка, починка, изменение тарифа сервера и перенос контейнера между галактиками. Остальное платформа не журналирует, и такие действия проходят мимо этого поля. Значение unknown в status означает третье состояние: операция начиналась, а её исход неизвестен — ждать завершения бессмысленно, состояние нужно перечитать по самому серверу.
• Состояние сервера приходит заглавными буквами. В карточке server.status для работающего сервера равен RUNNING, тогда как GET /v1/infra/servers для того же сервера в тот же момент отдаёт running. Клиент, который сверяет строки от обоих разделов, обязан приводить регистр.

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

• Список приложений
• Витрина приложений
• Серверы
• Хранилище исходников
• Ключи и авторизация
• Ошибки