CONFIG RESTAPI KEY LIST

Level

apikey

History

Appears in 5.0.1

Usage

[state=<active|revoked|expired|all]>: The state of the keys included in the list. Set to 'all' by default
[notUsedSince=<unsigned int>]: The minimum amount of time since the last use of the keys included in the list, in days.
[expiredInNext=<unsigned int>]: The maximum amount of time in which the keys included in the list will expire, in days.

Description

Lists all of the keys belonging to the current user fitting the specified filters. If executed by the superadmin, all keys fitting the parameters are listed regardless of their owner.

Format

section_line

Returns

key="1e6c41b5493fb9b2" rights="base" owner="user" comments="Un commentaire" creation_date="YYYY-MM-DD HH:mm:ss" expiration_date="YYYY-MM-DD HH:mm:ss" state="revoked" revocation_date="YYYY-MM-DD HH:mm:ss" last_use_date="YYYY-MM-DD HH:mm:ss"
key="42869ab44532db9f" rights="base" owner="user2" comments="Un commentaire" creation_date="YYYY-MM-DD HH:mm:ss" expiration_date="YYYY-MM-DD HH:mm:ss" state="active"

Remark

notUsedSince and expiredInNext are optional and must be stricly positive.
expiredInNext does not exclude expired keys, unless specified in state.
notUsedSince does not exclude keys that have never been used.

Example

CONFIG RESTAPI KEY LIST state=all notUsedSince=100 expiredInNext=30
CONFIG RESTAPI KEY LIST