API密钥

/api/api-key端点用于API密钥的CRUD管理。

DELETE /api/api-key/:id

删除ApiKey。

您必须具备超级用户权限才能执行此操作。

参数

• id的值必须是大于零的整数。

GET /api/api-key/

获取默认作用域下的API密钥列表。非分页。

您必须具备超级用户权限才能执行此操作。

GET /api/api-key/count

获取数据库中默认作用域下的API密钥数量。

您必须具备超级用户权限才能执行此操作。

参数

• _body

POST /api/api-key/

使用提供的名称和组ID创建一个新的API密钥（和相关 用户）。

您必须具备超级用户权限才能执行此操作。

参数

• group_id 值必须是一个大于零的整数。

• name 值必须是一个非空字符串。

• _body

PUT /api/api-key/:id

通过更改其组及其名称来更新API密钥。

您必须具备超级用户权限才能执行此操作。

参数

• id的值必须是大于零的整数。

• group_id 可空值必须是一个大于零的整数。

• name 可空值必须是一个非空字符串。

• _body

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

重新生成API密钥。

您必须具备超级用户权限才能执行此操作。

参数

• id的值必须是大于零的整数。

---

« 返回API索引