Перейти к содержанию

API ключ

/api/api-key методы для CRUD управления API ключами.

DELETE /api/api-key/:id

Удаляет Api ключ.

Вы должны быть суперпользователем для этого.

ПАРАМЕТРЫ:

  • id значение должно быть целым числом, больше ноля.

GET /api/api-key/

Получает список API ключей с областью видимости по умолчанию. Без разбивки на страницы.

Вы должны быть суперпользователем для этого.

GET /api/api-key/count

Получает количество API ключей в базе данных с областью видимости по умолчанию.

Вы должны быть суперпользователем для этого.

ПАРАМЕТРЫ:

  • _body

POST /api/api-key/

Создает новый API ключ (и связанного Пользователя) с соответствующим именем и ID группы.

Вы должны быть суперпользователем для этого.

ПАРАМЕТРЫ:

  • group_id целое число больше ноля.

  • name не пустое строковое значение.

  • _body

PUT /api/api-key/:id

Обновляет API ключ меняя его группу и/или имя.

Вы должны быть суперпользователем для этого.

ПАРАМЕТРЫ:

  • id целое значение больше ноля.

  • group_id обнуляемое целое значение больше ноля.

  • name обнуляемое непустое строковое значение.

  • _body

PUT /api/api-key/:id/regenerate

Генерирует API ключ.

Вы должны быть суперпользователем для этого.

ПАРАМЕТРЫ:

  • id целое значение больше ноля.

<< Назад к разделу API