List enrollment tokens

Returns the client's enrollment tokens with their status, usage counts, and expiry. The response does not include token values. To get the value of an active token, use the get enrollment token value endpoint.

To find the token to use for an agent deployment, send filter[status]=eq:active. If the response has no tokens, create a new one.

filter[status] supports the eq operator only, with one of active, expired, exhausted, or revoked.

sort accepts created_at, expires_at, or status, with a - prefix for descending order. Defaults to created_at descending.

Pagination is cursor-based and best-effort/non-atomic: rows may be skipped or duplicated between page requests if the underlying data changes concurrently.

Requires the amm.enrollment-tokens:read scope.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required

The client's ScalePad Core identifier. This is the id that the Core API returns for the client.

Query Params
filter
object

Filter map: filter[field]=op:value. Supported field and operator: status (eq — active, expired, exhausted, or revoked).

string
^[+-]?[a-z][a-z0-9_]*(\.[a-z][a-z0-9_]*)*(,[+-]?[a-z][a-z0-9_]*(\.[a-z][a-z0-9_]*)*)*$

Sort field: created_at, expires_at, or status. Prefix the field with - for descending order. Defaults to created_at descending.

integer
1 to 200
Defaults to 50

Number of rows per page (1-200). Values outside this range are clamped to it.

string

Opaque pagination cursor from a previous response's next_cursor. Pagination is best-effort and non-atomic: rows may be skipped or duplicated across page requests if the underlying data changes between calls.

Responses

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json