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

Creodock API

Все операции
PATCHИнтерфейс Creodock

Переименовать API-ключ

Изменяет только отображаемое имя с optimistic version.

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

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

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

  • Изменяет существующий ресурс. Передавайте только актуальные данные объекта.
  • Идемпотентность явно не объявлена в контракте: не повторяйте запрос автоматически.

Параметры

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

ПолеГдеТипОписание
organizationIdОбязательно
pathstring · uuid
ID рабочей области. Возьмите его из URL рабочей области или ответа списка рабочих областей.
keyIdОбязательно
pathstring · uuid
Идентификатор ресурса в пути запроса: keyId.

Тело запроса

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

application/json
ПолеТипОписание
nameОбязательно
string
Отображаемое название.Минимальная длина: 2 · Максимальная длина: 80
versionОбязательно
integer
Версия объекта для защиты от конфликтующих изменений.Минимум: 1

Ответы

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

200

Updated safe key summary

409

Problem Details response

application/json

Схема: Problem

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

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

СтатусЧто означаетПовторЧто делать
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": "Выберите формат." }
  ]
}