v1

latestOpenAPI 3.0.0Apache 2.02026-07-24340250799.5 KB
agents

List Agents

The endpoint returns a list of agents by various filters.

get/agents

Query parameters

filter[agent]string

The agent identifier.

filter[agent-pool]string

The agent pool identifier.

filter[name]string

The agent name.

filter[mtls-certificate-fingerprint]string

Partial SHA-256 fingerprint of the agent's mTLS certificate (case-insensitive, colons stripped).

filter[mtls-certificate-status]string

The mTLS certificate status. Accepts a single value or the in: operator with a comma-separated list (e.g. in:active,expired).

filter[mtls-certificate-not-valid-after]string

The mTLS certificate expiration time.

page[number]string

Page number

page[size]string

Page size

includestring[]

The comma-separated list of relationship paths.

sortstring[]

The comma-separated list of attributes.

Response

Success.