Документация · v1

Creodock API

Все операции
POSTИнтерфейс CreodockИдемпотентная команда

Создать: рабочая область

Безопасно создаёт рабочая область на основании переданного тела запроса.

POSThttps://api.creodock.com/api/v1/organizations/{organizationId}/integrations
Кто вызывает
Интерфейс Creodock
Операция выполняется от имени вошедшего пользователя через защищённую cookie-сессию.
Доступ
Определяется ролью и принадлежностью объекта
Отдельный scope не объявлен в OpenAPI. Сервер проверяет роль и рабочую область.

Что произойдёт

Поведение, которое важно учесть до отправки запроса.

  • Создаёт ресурс или запускает команду, описанную в теле запроса.
  • Поддерживает Idempotency-Key: повторяйте запрос с тем же ключом после сетевого сбоя.

Параметры

Где передать значение, обязательно ли оно и откуда его получить.

ПолеГдеТипОписание
organizationIdОбязательно
pathstring · uuid
ID рабочей области. Возьмите его из URL рабочей области или ответа списка рабочих областей.
Idempotency-KeyОбязательно
headerstring
Уникальный ключ команды. Используйте UUID и сохраняйте тот же ключ при безопасном повторе запроса.Минимальная длина: 16 · Максимальная длина: 128

Тело запроса

Обязательно для этой операции.

application/json

Схема: IntegrationConnectionInput

ПолеТипОписание
bucketОбязательно
string
Поле «bucket» в структуре запроса или ответа.
directionIdОбязательно
string · uuid
Поле «directionId» в структуре запроса или ответа.
endpointОбязательно
string · uri
Поле «endpoint» в структуре запроса или ответа.
nameОбязательно
string
Отображаемое название.

Ответы

Все состояния ответа, объявленные этой операцией в OpenAPI.

201

Created connection

application/json

Схема: IntegrationConnection

ПолеТипОписание
availableActionsОбязательно
string[]
Поле «availableActions» в структуре запроса или ответа.
bucketНеобязательно
object
Поле «bucket» в структуре запроса или ответа.
directionIdОбязательно
string · uuid
Поле «directionId» в структуре запроса или ответа.
endpointНеобязательно
object
Поле «endpoint» в структуре запроса или ответа.
healthОбязательно
string
Поле «health» в структуре запроса или ответа.Допустимо: healthy, attention, unknownПример: healthy
idОбязательно
string · uuid
Уникальный идентификатор объекта.
nameОбязательно
string
Отображаемое название.
ownerNameОбязательно
string
Поле «ownerName» в структуре запроса или ответа.
providerОбязательно
string
Поле «provider» в структуре запроса или ответа.Допустимо: s3, telegramПример: s3
statusОбязательно
IntegrationConnectionStatus
Текущий статус объекта.Допустимо: active, paused, attention, disconnectedПример: active
updatedAtОбязательно
string · date-time
Дата и время последнего изменения в ISO 8601.
versionОбязательно
integer · int64
Версия объекта для защиты от конфликтующих изменений.
{
  "availableActions": [
    "string"
  ],
  "directionId": "00000000-0000-0000-0000-000000000000",
  "health": "healthy",
  "id": "00000000-0000-0000-0000-000000000000",
  "name": "string",
  "ownerName": "string",
  "provider": "s3",
  "status": "active",
  "updatedAt": "2026-09-05T12:00:00Z",
  "version": 1
}
403

Problem Details response

application/json

Схема: Problem

409

Problem Details response

application/json

Схема: Problem

Ошибки и восстановление

Не только причина, но и конкретное действие для вызывающей стороны.

СтатусЧто означаетПовторЧто делать
403Недостаточно правНетИспользуйте ключ или роль с требуемым доступом.
409Конфликт состояния или версииПосле чтенияПолучите актуальный объект и повторите изменение.

Формат Problem Details

{
  "type": "https://api.creodock.com/problems/invalid-request",
  "title": "Данные не прошли проверку",
  "status": 422,
  "code": "invalid_request",
  "detail": "Проверьте отмеченные поля.",
  "traceId": "req_01J8M4Y6QX",
  "fieldErrors": [
    { "field": "items[0].formats", "code": "required", "message": "Выберите формат." }
  ]
}