Management

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

Частичное обновление: имя, обратимое отключение (disabled), лимит расхода (limit_kopecks, null — снять) и период его сброса (limit_period), режим «только чтение», привязка к адресу (allowed_ips, null — снять), защита от всплеска, режим приватности. Устаревшее daily_limit_kopecks = лимит с периодом day.

patch/v1/keys/{id}

Request

  • Base URL: https://api.hubris.pw
  • URL: https://api.hubris.pw/v1/keys/{id}
  • Auth: HTTP bearer

Path parameters

idstring uuid required

Request body

namestring
disabledboolean
limit_kopecksinteger nullable
limit_period'day' | 'week' | 'month' | 'none'

Период сброса лимита: day (по умолчанию), week, month, none — без сброса.

daily_limit_kopecksinteger nullable
read_onlyboolean

Переключить «только чтение»; обратимо.

allowed_ipsstring[] nullable

Привязка к адресу: до 32 записей — IPv4/IPv6-адрес или подсеть (CIDR). null или [] — снять привязку (любой адрес).

spike_limit_kopecksinteger nullable

Защита от всплеска: порог в копейках; null — выключить. Вместе с ним обязателен spike_window_minutes.

spike_window_minutesinteger

Окно защиты: 1, 5, 15, 30 или 60 минут.

spike_cooldown_minutesinteger nullable

Охлаждение: 15, 60, 360, 1440 минут или null — до ручного включения.

privacy_mask_default'inherit' | 'off' | 'on' | 'required'

Example request

{
  "allowed_ips": [
    "203.0.113.5",
    "198.51.100.0/24"
  ]
}

Response

Обновлённый ключ.

idstring uuid required
namestring required
key_prefixstring required
disabledboolean required
limit_kopecksinteger nullable required

Лимит расхода ключа в копейках за период limit_period. null = без лимита.

limit_period'day' | 'week' | 'month' | 'none' required

Период сброса лимита: day — календарные сутки (00:00 МСК), week — с понедельника, month — с 1-го числа, none — без сброса (лимит на весь расход ключа).

spent_period_kopecksinteger required

Потрачено этим ключом в текущем периоде, в копейках.

limit_remaining_kopecksinteger nullable required

Сколько ещё можно потратить в текущем периоде: лимит минус траты минус резервы роликов в работе, не меньше 0. null — без лимита.

period_reset_atstring nullable required

Момент следующего сброса (ISO 8601); null для limit_period=none.

daily_limit_kopecksinteger nullable required

Устаревшее. Равно limit_kopecks при limit_period=day, иначе null. Используйте limit_kopecks.

spent_24h_kopecksinteger required

Устаревшее. Равно spent_period_kopecks. Используйте spent_period_kopecks.

read_onlyboolean required

Ключ только для чтения: каталог моделей, баланс и статистика доступны, запросы к моделям (всё, что тратит баланс) — 403 key_read_only.

allowed_ipsstring[] nullable required

Привязка к адресу: IPv4/IPv6-адреса и подсети (CIDR), с которых ключ принимает запросы; null — с любого адреса. Запрос с другого адреса — 403 key_ip_not_allowed.

disabled_reason'manual' | 'spike' nullable required

Почему ключ отключён: manual — вручную, spike — заморозка при всплеске трат; null — включён.

disabled_untilstring nullable required

Момент автоматического включения после заморозки (ISO 8601); null — до ручного включения или ключ включён.

spike_limit_kopecksinteger nullable required

Защита от всплеска: порог расхода в копейках за окно spike_window_minutes; null — выключена.

spike_window_minutesinteger nullable required

Окно защиты от всплеска: 1, 5, 15, 30 или 60 минут.

spike_cooldown_minutesinteger nullable required

Период охлаждения: через сколько минут ключ включится снова (15, 60, 360, 1440); null — до ручного включения.

privacy_mask_default'inherit' | 'off' | 'on' | 'required' required
last_used_atstring nullable required
created_atstring required

Example response

{
  "key_prefix": "sk-gw-ab12...cd34",
  "allowed_ips": [
    "203.0.113.5",
    "198.51.100.0/24"
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.