Обновить ключ API

Включает/отключает ключ или устанавливает/очищает лимит расходов — каждый вызов выполняет только одно из этих действий, а не оба одновременно. Конечная точка управления с тем же правилом, что и создание ключа: токен Bearer должен быть ключом управления API или использовать сеанс с входом в систему.

PATCH/api/v1/keys/:id

Авторизация

Authorizationобязательно

string · header

Ключ API как Bearer-токен в заголовке Authorization.

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

idобязательно

string

Идентификатор ключа для обновления.

Тело

enabled

boolean

Включите (true) или отключите (false) этот ключ. Любое ручное переключение сбрасывает предыдущий флаг автоматического отключения лимита расходов, поэтому ключ никогда не автоматически автоматически повторно включается позже против вашего намерения.

spendLimitUsd

number | null

Устанавливает лимит расходов в USD; передайте значение null, чтобы очистить лимит. Взаимоисключающее с включенным — один запрос может отправить только одно или другое.

positive, ≤1,000,000

spendLimitPeriod

string | null

Период сброса лимита расходов. Требуется всякий раз, когда задана тратаLimitUsd, и принимает только необработанные значения дня/недели/месяца — в отличие от конечной точки создания ключа, здесь НЕ принимаются псевдонимы «день/неделя/месяц».

dayweekmonth

PATCH /api/v1/keys/:id

1
2
3
4
curl -X PATCH https://bazaarlink.ai/api/v1/keys/key_abc123 \
  -H "Authorization: Bearer $BAZAARLINK_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"enabled": false}'

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

Обновлено. Ответ — это просто флаг подтверждения, а не полная запись ключа — вызовите ключи списка еще раз, чтобы увидеть текущее состояние.

1
2
3
{
  "updated": true
}