provod.ai / docs
API

Изменить API-ключ

Изменение названия, лимита, срока действия и состояния API-ключа.

Обновлено

PATCH /v1/keys/{hash}

Измените название, состояние, срок действия или лимит ключа. Пропущенные поля сохраняют текущие значения.

Авторизация

Authorization: Bearer <MANAGEMENT_API_KEY>: управляющий ключ выбранного рабочего пространства. У создателя ключа проверяется действующее право apiKeys.create.

Рабочее пространство определяется ключом. Заголовок X-Org-Id не поддерживается.

Параметры пути

ПолеТипОписание
hashstring · обязательноSHA-256 из data.hash при создании или из списка. Не секрет и не внутренний ID.

Тело запроса

Content-Type: application/json

ПолеТипОписание
namestringОт 1 до 80 символов после удаления пробелов по краям. Обязательно при создании.
limitnumber | nullОт 0 до 9999999999.99, до 8 знаков после запятой. null снимает лимит; 0 блокирует новые платные запросы.
limit_resetstring | nulldaily, weekly, monthly или null (за всё время). Календарные периоды UTC. Для периодического сброса нужен лимит.
disabledbooleanПри создании по умолчанию false. true отключает новые запросы, false снова включает ключ.
expires_atstring | nullДата и время ISO в UTC, например 2030-01-01T00:00:00Z. null снимает срок действия.
workspace_idstringНеобязательная непустая строка для проверки текущего пространства. Не переключает пространство.
include_byok_in_limitfalseДопускается только false. BYOK недоступен.

Неизвестные поля отклоняются. При создании пропущенный limit означает отсутствие лимита, limit_reset означает лимит за всё время, expires_at означает отсутствие срока действия.

Передайте хотя бы одно поле. Если у ключа несколько лимитов кабинета, менять limit или limit_reset нужно в кабинете. Новый лимит учитывает уже накопленные расходы в периоде. Отключение не отменяет принятые запросы и их оплату.

Ответ · 200

ПолеТипОписание
dataobjectОбъект ключа.

Каждый объект включает поля текущего ключа и следующие поля:

ПолеТипОписание
hashstringХеш SHA-256 для обращения к ключу.
namestringНазвание ключа.
disabledbooleanБлокируются ли новые запросы.
created_atstring (date-time)Время создания.
updated_at, last_used_atstring | nullДаты ISO или null, если отсутствуют.

При нескольких лимитах limit, limit_reset и limit_remaining равны null; читайте spend_limits. is_management_key всегда false.

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

Все идентификаторы и суммы в примерах условные.

Пример запроса

Загрузите ключ в переменную окружения на сервере. TypeScript использует встроенный fetch в Node.js, Python только стандартную библиотеку.

Замените пример хеша на data.hash своего ключа.

const response = await fetch("https://api.provod.ai/v1/keys/aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", {
  method: "PATCH",
  headers: {
    Authorization: `Bearer ${process.env.MANAGEMENT_API_KEY}`,
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "disabled": true
  }),
});
if (!response.ok) throw new Error(`${response.status}: ${await response.text()}`);
console.log(await response.json());

Ошибки

HTTPОшибкаПричина
401UnauthorizedОтсутствующий, недействительный, отключённый, отозванный или истёкший ключ. Заголовок X-Org-Id также отклоняется.
403ForbiddenНеверный тип ключа или недостаточно прав в рабочем пространстве.
400Bad RequestНеверные или неизвестные параметры.
404Not FoundКлюч не найден, отозван или принадлежит другому пространству.

Пример ошибки авторизации:

{
  "error": {
    "code": "invalid_api_key",
    "message": "Invalid API key",
    "metadata": {}
  }
}

Пример ошибки метода:

{
  "message": "API key not found",
  "error": "Not Found",
  "statusCode": 404
}

Далее

На этой странице