List agents
List all agent instances in the organization.
List all agent instances in the organization.
ApiKeyAuthAuthorizationBearer <token>Bearer token authentication. Send an API key (a saai_api_-prefixed token) as Authorization: Bearer <token>.
Required permission
view_agent_instancesoffset?integerNumber of items to skip before returning results.
int320 <= value0limit?integerMaximum number of items to return per page.
int320 <= value <= 25610search?stringFree-text search term to filter results by name. Also matches the owning user's display name.
length <= 255agent_slug?array<string>user_id?array<>autonomous?booleanOnly autonomous instances (no owning user) when true, only user-bound ones when false. Unset returns both.
scope?stringown returns only the caller's own records, even when they may see the whole organization. all, the default, returns everything the caller may see. It never widens what the caller may see.
"all""own"sort_by?stringField to sort a list of agent instances by.
"created_at""created_at""display_name""last_used_at"sort_order?stringDirection to sort results.
"desc""asc""desc"The request has succeeded.
application/json- response
A page of results together with its paging information.
items*array<>The items in this page.
meta*Paging information for a list response.
curl -X GET 'https://your-org.aisecurity.services.us.connect.secureauth.com/api/v1/agent-instances'{ "items": [ { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "user_id": "a169451c-8525-4352-b8ca-070dd449a1a5", "user_display_name": "string", "autonomous": true, "display_name": "string", "metadata": { "client_name": "string", "client_version": "string", "protocol_version": "string", "user_agent": "string", "ip_address": "string" }, "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "last_used_at": "2019-08-24T14:15:22Z", "revoked_at": "2019-08-24T14:15:22Z", "agent_slug": "string", "external_id": "string", "token_endpoint_auth_method": "string", "is_dcr_managed": true } ], "meta": { "total": 0, "offset": 0, "limit": 0 }}