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

Creodock API

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

Создать API-ключ

Создаёт live-ключ. Секрет присутствует только в этом ответе и не может быть восстановлен.

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

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

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

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

Параметры

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

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

Тело запроса

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

application/json

Схема: APIKeyCreate

ПолеТипОписание
expiresInDaysНеобязательно
integer
Поле «expiresInDays» в структуре запроса или ответа.Допустимо: 0, 30, 90, 180, 365Пример: 90
nameОбязательно
string
Отображаемое название.Минимальная длина: 2 · Максимальная длина: 80
presetОбязательно
string
Поле «preset» в структуре запроса или ответа.Допустимо: read_only, workspace, full_workspace, customПример: read_only
scopesНеобязательно
string[]
Поле «scopes» в структуре запроса или ответа.

Ответы

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

201

One-time API key secret and safe summary

application/json

Схема: APIKeyOneTimeSecret

ПолеТипОписание
keyОбязательно
object
Поле «key» в структуре запроса или ответа.
oneTimeОбязательно
boolean
Поле «oneTime» в структуре запроса или ответа.
secretОбязательно
string
Поле «secret» в структуре запроса или ответа.Формат: ^cdk_live_
{
  "key": {},
  "oneTime": true,
  "secret": "string"
}
403

Problem Details response

application/json

Схема: Problem

409

Problem Details response

application/json

Схема: Problem

422

Problem Details response

application/json

Схема: Problem

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

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

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

Формат 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": "Выберите формат." }
  ]
}