CONFIG RESTAPI KEY EDIT

Level

apikey,modify

History

Appears in 5.0.1

Usage

id=<string>: The id of the key to edit.
[comments=<string>]: Comments on the key, which will overwrite the previous comments of this key. (can be left empty)
[dateDecrease=<int>]: Number of days to decrease the targeted key's expiration date of. The key will be unaffected if it makes its lifespan shorter than the minimum lifespan in the configuration.

Description

Edits the specified public API key with the given parameters.
An administrator can only edit the keys they own, while the superadministrator can edit any key.

Returns

Error code

Remark

If left unspecified, the comment will not be modified.

Example

CONFIG RESTAPI KEY EDIT id=da6806c4b823f822 comments="This is a new comment for a basic key" dateDecrease=10