Api Tokens Overview Api List All Api Tokens
Returns one page of token metadata with the owner's username, newest first (createdAt, then internal id, both descending; the order cannot be changed). Includes revoked and expired tokens. It never returns the token, its digest or key material. Answers 404 API_TOKENS_DISABLED while the feature flag is off. Bearer tokens cannot call this route. To revoke a token found here, use DELETE /api/v1/users/{userId}/api-tokens/{tokenId} with the token's ownerUserId.
Only tokens in this status; omit for every status
ACTIVE
Case-insensitive substring of the token name or the owner's username, matched literally (LIKE metacharacters are escaped)
siem
Zero-based page index (default: 0)
Number of items per page (default 20, 1 to 100). A size outside 1 to 100 answers 400 INVALID_PAGE_SIZE.
20
200 OK successful response envelope. A page of token metadata with owner usernames, with no secret material
{
"content": [
{
"tokenId": "k3x7q2m9z4tb",
"ownerUserId": 3,
"ownerUsername": "svc-siem",
"name": "siem-readonly",
"access": "READ_ONLY",
"status": "ACTIVE",
"createdAt": "2026-01-15T09:30:00Z",
"createdBy": "alice",
"expiresAt": "2026-02-14T09:30:00Z",
"lastUsedAt": "2026-01-16T08:15:00Z",
"revokedAt": null
}
],
"totalElements": 1,
"totalPages": 1,
"number": 0,
"size": 20,
"numberOfElements": 1,
"first": true,
"last": true,
"empty": false
}
The tokens on the requested page
Total number of tokens matching the filters
Total number of pages at the requested page size
Zero-based page index
Requested page size
Number of items on this page
True when this is the first page
True when this is the last page
True when this page holds no items
400 Bad Request: INVALID_PAGE_SIZE when size is outside 1 to 100; INVALID_ARGUMENT when status is not ACTIVE, EXPIRED or REVOKED or a parameter has the wrong type
{
"errorCode": "string",
"message": "string",
"path": "string",
"timestamp": "string",
"reason": "string"
}
Stable machine-readable error code. The known values are listed in ApiErrorCode; the set is not closed, so a client must tolerate an unlisted value.
Human-readable error description
Request URI path that produced the error
Timestamp when the error occurred as an ISO 8601 date-time with offset
A finer code, present only where an endpoint documents it. The Rule Pack endpoints' PACK_ENTRY_INVALID carries the import core's code here.
401 Unauthorized: UNAUTHENTICATED when the VTP_SESSION cookie is missing, unknown, expired or revoked
{
"errorCode": "string",
"message": "string",
"path": "string",
"timestamp": "string",
"reason": "string"
}
Stable machine-readable error code. The known values are listed in ApiErrorCode; the set is not closed, so a client must tolerate an unlisted value.
Human-readable error description
Request URI path that produced the error
Timestamp when the error occurred as an ISO 8601 date-time with offset
A finer code, present only where an endpoint documents it. The Rule Pack endpoints' PACK_ENTRY_INVALID carries the import core's code here.
403 Forbidden: FORBIDDEN when the signed-in role is not allowed to call this operation; PASSWORD_CHANGE_REQUIRED when the account must change its password first (only GET /api/v1/auth/session, POST /api/v1/auth/logout and POST /api/v1/auth/change-password are exempt); LICENSE_REQUIRED or LICENSE_EXPIRED while the license pool is restricted (no license, or expired past grace) (exempt: every route under /api/v1/auth, GET /api/v1/user/preferences, GET /api/v1/licensing/summary and POST /api/v1/licensing/licenses)
{
"errorCode": "string",
"message": "string",
"path": "string",
"timestamp": "string",
"reason": "string"
}
Stable machine-readable error code. The known values are listed in ApiErrorCode; the set is not closed, so a client must tolerate an unlisted value.
Human-readable error description
Request URI path that produced the error
Timestamp when the error occurred as an ISO 8601 date-time with offset
A finer code, present only where an endpoint documents it. The Rule Pack endpoints' PACK_ENTRY_INVALID carries the import core's code here.
404 Not Found error response (API_TOKENS_DISABLED while the feature flag is off)
{
"errorCode": "string",
"message": "string",
"path": "string",
"timestamp": "string",
"reason": "string"
}
Stable machine-readable error code. The known values are listed in ApiErrorCode; the set is not closed, so a client must tolerate an unlisted value.
Human-readable error description
Request URI path that produced the error
Timestamp when the error occurred as an ISO 8601 date-time with offset
A finer code, present only where an endpoint documents it. The Rule Pack endpoints' PACK_ENTRY_INVALID carries the import core's code here.
curl -H 'Authorization: <value>' https://{api_host}/api/v1/api-tokens