apitoken list

Prev Next

This command displays API tokens and their details.

Usage

apitoken list [--archived]
              [--owner OWNER]

Options

--archived

Includes archived tokens in the list.  Tokens are archived when they are revoked.

--owner OWNER

Displays tokens owned by a specific manager user. Specify OWNER as a string, the user name of a manager.

Example

vcli: admin> apitoken list
+----------+--------------------+--------+---------------------+---------------------+---------+-----------------+
| ID       | Name               | Owner  | Expiry-date         | Last-used           | Revoked | Revocation-time |
+----------+--------------------+--------+---------------------+---------------------+---------+-----------------+
| c6UmISHU | example_api_token  | admin  | 2025-06-18 11:59:00 | None                | False   | None            |
| RWDLagfI | example2_api_token | admin2 | 2025-05-19 12:00:00 | 2025-02-19 11:30:04 | False   | None            |
+----------+--------------------+--------+---------------------+---------------------+---------+-----------------+

Command Output

ID

Token ID

Name

Token name

Owner

Token owner

Expiry-date

The token's expiration date.

Last-used

The time when the token was last used to authenticate to the VMS REST API.

Revoked

True if the token has been revoked. False otherwise.

Revocation-time

The time at which the token was revoked, if applicable.