ENЗапросить демонстрацию

Справочник API

Ключи API

Выпуск, приостановка и отзыв ключей.

Список ключей API

GET/v1/api-keys

Области доступа
keys:read

Параметры

ПолеТипОбязательно
cursorзапросstringнет
limitзапросintegerнет

Ответы

  • 200KeyList
  • 400
  • 401
  • 403
  • 404
  • 409
  • 412
  • 413
  • 415
  • 422
  • 428
  • 429
  • 503

Создать ключ API

POST/v1/api-keys

Области доступа
keys:write
Обязательный заголовок
Idempotency-Key

Тело запросаKeyCreate

ПолеТипОбязательно
namestringда
scopesarray of stringда
expires_atstring (date-time)да
environmentenum: test, liveда

Ответы

  • 201KeyIssued
  • 400
  • 401
  • 403
  • 404
  • 409
  • 412
  • 413
  • 415
  • 422
  • 428
  • 429
  • 503

Отозвать ключ API

POST/v1/api-keys/{key_id}/revoke

Области доступа
keys:write
Обязательный заголовок
Idempotency-Key

Параметры

ПолеТипОбязательно
key_idпутьstring (uuid)да

Тело запросаReasonAction

ПолеТипОбязательно
reason_codestringда
notestringнет

Ответы

  • 200Key
  • 400
  • 401
  • 403
  • 404
  • 409
  • 412
  • 413
  • 415
  • 422
  • 428
  • 429
  • 503

Приостановить ключ API

POST/v1/api-keys/{key_id}/suspend

Области доступа
keys:write
Обязательный заголовок
Idempotency-Key

Temporary containment: the key stops authenticating (403 credential_suspended) until resumed. Evidence and history are kept.

Параметры

ПолеТипОбязательно
key_idпутьstring (uuid)да

Тело запросаReasonAction

ПолеТипОбязательно
reason_codestringда
notestringнет

Ответы

  • 200Key
  • 400
  • 401
  • 403
  • 404
  • 409
  • 412
  • 413
  • 415
  • 422
  • 428
  • 429
  • 503

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

POST/v1/api-keys/{key_id}/resume

Области доступа
keys:write
Обязательный заголовок
Idempotency-Key

Restores a suspended key. Revoked or expired keys cannot be resumed.

Параметры

ПолеТипОбязательно
key_idпутьstring (uuid)да

Тело запросаReasonAction

ПолеТипОбязательно
reason_codestringда
notestringнет

Ответы

  • 200Key
  • 400
  • 401
  • 403
  • 404
  • 409
  • 412
  • 413
  • 415
  • 422
  • 428
  • 429
  • 503