CONFIG RESTAPI KEY CREATE

Level

apikey,modify

History

Appears in 5.0.1

Usage

[expirationDelay=<int>] : Number of days in which the key won't be usable anymore. Maximum duration is 25 years
[rights=<string>] : The rights to give to the key
[comments=<string>] : Comments on the key (can be left empty)

Description

Creates a new public API key with the given parameters

Returns

Key=<id>:<secret>

Remark

If successful, the generated secret will be shown, and will never be recoverable after the execution of this command.
The rights to give to the key must not exceed the rights of the user executing this command (who will be the key's owner).
The superadministrator can't create API keys.

Example

CONFIG RESTAPI CREATE expirationDelay=365 rights="base,vpn" comments="This is a basic key"