Api Tokens Overview Api List All Api Tokens

Api Tokens Overview Api List All Api Tokens
List the API tokens of every owner (Administrator only)

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.

Request
URI
GET
https://{api_host}/api/v1/api-tokens
COPY
Query Parameters
status
Optional

Only tokens in this status; omit for every status

status example
ACTIVE
string
q
Optional

Case-insensitive substring of the token name or the owner's username, matched literally (LIKE metacharacters are escaped)

q example
siem
integer
page
Optional
Constraints: minimum: 0 default: 0

Zero-based page index (default: 0)

integer
size
Optional
Constraints: minimum: 1 maximum: 100 default: 20

Number of items per page (default 20, 1 to 100). A size outside 1 to 100 answers 400 INVALID_PAGE_SIZE.

size example
20

Authentication
This operation uses the following authentication methods.
Responses
200

200 OK successful response envelope. A page of token metadata with owner usernames, with no secret material

Returns SpringPage_ApiTokenOverviewDto of type(s) application/json
{
    "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
}
array of object
content
Required  

The tokens on the requested page

integer As int64 As int64
totalElements
Required  

Total number of tokens matching the filters

integer As int32 As int32
totalPages
Required  

Total number of pages at the requested page size

integer As int32 As int32
number
Required  

Zero-based page index

integer As int32 As int32
size
Required  

Requested page size

integer As int32 As int32
numberOfElements
Optional

Number of items on this page

boolean
first
Optional

True when this is the first page

boolean
last
Optional

True when this is the last page

boolean
empty
Optional

True when this page holds no items


400

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

Returns ApiErrorResponse of type(s) application/json
{
    "errorCode": "string",
    "message": "string",
    "path": "string",
    "timestamp": "string",
    "reason": "string"
}
errorCode
Required  

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.

string
message
Required  

Human-readable error description

string
path
Required  

Request URI path that produced the error

string As date-time As date-time
timestamp
Required  

Timestamp when the error occurred as an ISO 8601 date-time with offset

string
reason
Optional

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

401 Unauthorized: UNAUTHENTICATED when the VTP_SESSION cookie is missing, unknown, expired or revoked

Returns Unauthenticated of type(s) application/json
{
    "errorCode": "string",
    "message": "string",
    "path": "string",
    "timestamp": "string",
    "reason": "string"
}
errorCode
Required  

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.

string
message
Required  

Human-readable error description

string
path
Required  

Request URI path that produced the error

string As date-time As date-time
timestamp
Required  

Timestamp when the error occurred as an ISO 8601 date-time with offset

string
reason
Optional

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

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)

Returns ForbiddenRead of type(s) application/json
{
    "errorCode": "string",
    "message": "string",
    "path": "string",
    "timestamp": "string",
    "reason": "string"
}
errorCode
Required  

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.

string
message
Required  

Human-readable error description

string
path
Required  

Request URI path that produced the error

string As date-time As date-time
timestamp
Required  

Timestamp when the error occurred as an ISO 8601 date-time with offset

string
reason
Optional

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

404 Not Found error response (API_TOKENS_DISABLED while the feature flag is off)

Returns ApiErrorResponse of type(s) application/json
{
    "errorCode": "string",
    "message": "string",
    "path": "string",
    "timestamp": "string",
    "reason": "string"
}
errorCode
Required  

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.

string
message
Required  

Human-readable error description

string
path
Required  

Request URI path that produced the error

string As date-time As date-time
timestamp
Required  

Timestamp when the error occurred as an ISO 8601 date-time with offset

string
reason
Optional

A finer code, present only where an endpoint documents it. The Rule Pack endpoints' PACK_ENTRY_INVALID carries the import core's code here.


Code Samples
COPY
                    curl -H 'Authorization: <value>' https://{api_host}/api/v1/api-tokens