Public API v1

Интеграции

Безопасные метаданные подключений и маршруты провайдеров.

GET/projects/{projectId}/integration-settingsМаршрутизация интеграций проектаintegrations:read

Формат запроса

Path: projectId: UUID. JSON body отсутствует, если для метода явно не указано обратное.

Формат ответа

JSON { data: <типизированный результат>, meta: { requestId }, page?: { hasNext, nextCursor } }.

PATCH/projects/{projectId}/integration-settings/{bindingId}Изменить привязку интеграцииintegrations:write

Формат запроса

Path: projectId: UUID, bindingId: UUID. Content-Type: application/json; неизвестные поля отклоняются.

Формат ответа

JSON { data: <типизированный результат>, meta: { requestId }, page?: { hasNext, nextCursor } }.

GET/workspaces/{workspaceId}/integrations/catalogКаталог провайдеров и возможностейintegrations:read

Формат запроса

Path: workspaceId: UUID. JSON body отсутствует, если для метода явно не указано обратное.

Формат ответа

JSON { data: <типизированный результат>, meta: { requestId }, page?: { hasNext, nextCursor } }.

GET/workspaces/{workspaceId}/integrations/credentialsБезопасные метаданные подключений без секретовintegrations:read

Формат запроса

Path: workspaceId: UUID. JSON body отсутствует, если для метода явно не указано обратное.

Формат ответа

JSON { data: <типизированный результат>, meta: { requestId }, page?: { hasNext, nextCursor } }.

GET/workspaces/{workspaceId}/integrations/routingМаршруты провайдеров рабочей областиintegrations:read

Формат запроса

Path: workspaceId: UUID. JSON body отсутствует, если для метода явно не указано обратное.

Формат ответа

JSON { data: <типизированный результат>, meta: { requestId }, page?: { hasNext, nextCursor } }.

PUT/workspaces/{workspaceId}/integrations/routing/{capability}Заменить маршрут выбранной возможностиintegrations:write

Формат запроса

Path: workspaceId: UUID, capability: string. Content-Type: application/json; неизвестные поля отклоняются.

Формат ответа

JSON { data: <типизированный результат>, meta: { requestId }, page?: { hasNext, nextCursor } }.

POST/workspaces/{workspaceId}/integrations/credentialsДобавить BYOK credentialintegrations:write

Формат запроса

Path: workspaceId: UUID. Content-Type: application/json; неизвестные поля отклоняются.

Формат ответа

JSON { data: <типизированный результат>, meta: { requestId }, page?: { hasNext, nextCursor } }.

POST/workspaces/{workspaceId}/integrations/platform-credentialsПодключить системный credentialintegrations:write

Формат запроса

Path: workspaceId: UUID. Content-Type: application/json; неизвестные поля отклоняются.

Формат ответа

JSON { data: <типизированный результат>, meta: { requestId }, page?: { hasNext, nextCursor } }.

PATCH/workspaces/{workspaceId}/integrations/credentials/{credentialId}Переименовать или заменить credentialintegrations:write

Формат запроса

Path: workspaceId: UUID, credentialId: UUID. Content-Type: application/json; неизвестные поля отклоняются.

Формат ответа

JSON { data: <типизированный результат>, meta: { requestId }, page?: { hasNext, nextCursor } }.

POST/workspaces/{workspaceId}/integrations/credentials/{credentialId}/validationsЗапустить безопасную проверку credentialintegrations:write

Формат запроса

Path: workspaceId: UUID, credentialId: UUID. Content-Type: application/json; неизвестные поля отклоняются.

Формат ответа

JSON { data: <типизированный результат>, meta: { requestId }, page?: { hasNext, nextCursor } }.

GET/workspaces/{workspaceId}/integrations/credentials/{credentialId}/validations/{validationId}Получить состояние проверки credentialintegrations:read

Формат запроса

Path: workspaceId: UUID, credentialId: UUID, validationId: UUID. JSON body отсутствует, если для метода явно не указано обратное.

Формат ответа

JSON { data: <типизированный результат>, meta: { requestId }, page?: { hasNext, nextCursor } }.

DELETE/workspaces/{workspaceId}/integrations/credentials/{credentialId}Отозвать credential и стереть его secret materialintegrations:write

Формат запроса

Path: workspaceId: UUID, credentialId: UUID. JSON body отсутствует, если для метода явно не указано обратное.

Формат ответа

204 No Content либо JSON { data, meta: { requestId } }, если команда возвращает ресурс.

POST/projects/{projectId}/integration-settingsСоздать project override маршрутаintegrations:write

Формат запроса

Path: projectId: UUID. Content-Type: application/json; неизвестные поля отклоняются.

Формат ответа

JSON { data: <типизированный результат>, meta: { requestId }, page?: { hasNext, nextCursor } }.

POST/projects/{projectId}/integration-settings/prepare-systemПодготовить доступные системные маршрутыintegrations:write

Формат запроса

Path: projectId: UUID. Content-Type: application/json; неизвестные поля отклоняются.

Формат ответа

JSON { data: <типизированный результат>, meta: { requestId }, page?: { hasNext, nextCursor } }.

POST/projects/{projectId}/integration-settings/{bindingId}/inheritВернуть маршрут к настройкам workspaceintegrations:write

Формат запроса

Path: projectId: UUID, bindingId: UUID. Content-Type: application/json; неизвестные поля отклоняются.

Формат ответа

JSON { data: <типизированный результат>, meta: { requestId }, page?: { hasNext, nextCursor } }.