Изменить API-ключ
Изменение названия, лимита, срока действия и состояния API-ключа.
Обновлено
PATCH /v1/keys/{hash}
Измените название, состояние, срок действия или лимит ключа. Пропущенные поля сохраняют текущие значения.
Авторизация
Authorization: Bearer <MANAGEMENT_API_KEY>: управляющий ключ выбранного рабочего пространства. У создателя ключа проверяется действующее право apiKeys.create.
Рабочее пространство определяется ключом. Заголовок X-Org-Id не поддерживается.
Параметры пути
| Поле | Тип | Описание |
|---|---|---|
hash | string · обязательно | SHA-256 из data.hash при создании или из списка. Не секрет и не внутренний ID. |
Тело запроса
Content-Type: application/json
| Поле | Тип | Описание |
|---|---|---|
name | string | От 1 до 80 символов после удаления пробелов по краям. Обязательно при создании. |
limit | number | null | От 0 до 9999999999.99, до 8 знаков после запятой. null снимает лимит; 0 блокирует новые платные запросы. |
limit_reset | string | null | daily, weekly, monthly или null (за всё время). Календарные периоды UTC. Для периодического сброса нужен лимит. |
disabled | boolean | При создании по умолчанию false. true отключает новые запросы, false снова включает ключ. |
expires_at | string | null | Дата и время ISO в UTC, например 2030-01-01T00:00:00Z. null снимает срок действия. |
workspace_id | string | Необязательная непустая строка для проверки текущего пространства. Не переключает пространство. |
include_byok_in_limit | false | Допускается только false. BYOK недоступен. |
Неизвестные поля отклоняются. При создании пропущенный limit означает отсутствие лимита, limit_reset означает лимит за всё время, expires_at означает отсутствие срока действия.
Передайте хотя бы одно поле. Если у ключа несколько лимитов кабинета, менять limit или limit_reset нужно в кабинете. Новый лимит учитывает уже накопленные расходы в периоде. Отключение не отменяет принятые запросы и их оплату.
Ответ · 200
| Поле | Тип | Описание |
|---|---|---|
data | object | Объект ключа. |
Каждый объект включает поля текущего ключа и следующие поля:
| Поле | Тип | Описание |
|---|---|---|
hash | string | Хеш SHA-256 для обращения к ключу. |
name | string | Название ключа. |
disabled | boolean | Блокируются ли новые запросы. |
created_at | string (date-time) | Время создания. |
updated_at, last_used_at | string | 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 | Ошибка | Причина |
|---|---|---|
401 | Unauthorized | Отсутствующий, недействительный, отключённый, отозванный или истёкший ключ. Заголовок X-Org-Id также отклоняется. |
403 | Forbidden | Неверный тип ключа или недостаточно прав в рабочем пространстве. |
400 | Bad Request | Неверные или неизвестные параметры. |
404 | Not Found | Ключ не найден, отозван или принадлежит другому пространству. |
Пример ошибки авторизации:
{
"error": {
"code": "invalid_api_key",
"message": "Invalid API key",
"metadata": {}
}
}Пример ошибки метода:
{
"message": "API key not found",
"error": "Not Found",
"statusCode": 404
}