Получить API-ключ
Настройки, расходы и остаток лимита API-ключа по его хешу.
Обновлено
GET /v1/keys/{hash}
Получите сведения об обычном API-ключе по хешу, включая расходы и лимиты.
Авторизация
Authorization: Bearer <MANAGEMENT_API_KEY>: управляющий ключ выбранного рабочего пространства. У создателя ключа проверяется действующее право apiKeys.read.
Рабочее пространство определяется ключом. Заголовок X-Org-Id не поддерживается.
Параметры пути
| Поле | Тип | Описание |
|---|---|---|
hash | string · обязательно | SHA-256 из data.hash при создании или из списка. Не секрет и не внутренний ID. |
Ответ · 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: "GET",
headers: {
Authorization: `Bearer ${process.env.MANAGEMENT_API_KEY}`,
},
});
if (!response.ok) throw new Error(`${response.status}: ${await response.text()}`);
console.log(await response.json());Ошибки
| HTTP | Ошибка | Причина |
|---|---|---|
401 | Unauthorized | Отсутствующий, недействительный, отключённый, отозванный или истёкший ключ. Заголовок X-Org-Id также отклоняется. |
403 | Forbidden | Неверный тип ключа или недостаточно прав в рабочем пространстве. |
404 | Not Found | Ключ не найден, отозван или принадлежит другому пространству. |
Пример ошибки авторизации:
{
"error": {
"code": "invalid_api_key",
"message": "Invalid API key",
"metadata": {}
}
}Пример ошибки метода:
{
"message": "API key not found",
"error": "Not Found",
"statusCode": 404
}