List agent sessions

Lists managed agent sessions using ID-based pagination and the requested sort order. See managing sessions.

limitinteger nullable

The maximum number of resources to return.

order'asc' | 'desc'

The order in which paginated resources are returned.

Sort order by the created_at timestamp. Use asc for ascending order or desc for descending order. Defaults to desc.

agent_idstring

Only return sessions whose root agent has this ID. Omit to return sessions for all agents.

afterstring

Return resources after this resource ID in the selected order.

Response

A page of sessions.

object'list' required

The object type, which is always list.

first_idstring nullable required

The ID of the first resource in data, or null if the page is empty.

last_idstring nullable required

The ID of the last resource in data, or null if the page is empty. Pass this as after with the same order and filters.

has_moreboolean required

Whether there are more resources to retrieve after this page.