Skip to content
Prefactor Docs

List agent instances

GET
/api/v1/agent_instance

Authorizations

Section titled “Authorizations ”

Parameters

Section titled “ Parameters ”

Query Parameters

Section titled “Query Parameters ”
agent_id
Agent_Id

A valid agent ID

string
Example
013xrzp12g3nqk8ns6jadrqmpgrjkeny
idempotency_key
One of:

Optional idempotency key for ensuring request idempotency

string
agent_version_id
AgentVersion_Id

A valid agent version ID

string
Example
013xrzp12g3nqk8ns6jadrqmpgrjkeny
sorting
string

Sort order; a field name, optionally prefixed with - for descending (e.g. -created_at).

pagination[offset]
integer

Zero-based offset of the first item to return.

pagination[page_size]
integer
>= 1 <= 100

Number of items to return per page (1-100).

Responses

Section titled “ Responses ”

200

Section titled “200 ”

Success

object
pagination
One of:
PaginationOutput

Pagination information

object
item_count

The total number of items

integer
item_end

The index of the last item in the page (one-based)

integer
item_start

The index of the first item in the page (one-based)

integer
next_page_offset
One of:

The offset of the next page (null if last page)

integer
page_count

The total number of pages

integer
page_index

The index of the current page (one-based)

integer
page_offset

The offset of the first item in the page (zero-based)

integer
page_size

The number of items per page

integer
previous_page_offset
One of:

The offset of the previous page (null if first page)

integer
Example
{
  "item_count": 200,
  "item_end": 100,
  "item_start": 91,
  "next_page_offset": 110,
  "page_count": 20,
  "page_index": 10,
  "page_offset": 90,
  "page_size": 10,
  "previous_page_offset": 80
}
sorting
One of:
Sorting

Sorting information

object
direction

The direction to sort by

string
Allowed values: asc desc
Example
asc
field

The field to sort by (values depend on the type of list)

string
Allowed values: id last_seen status title timestamp started_at finished_at email name external_identifier
Example
id
status
string
Allowed values: success
Example
success
summaries
Array<object>
AgentInstance_Summary
object
account_id
Account_Id

A valid account ID

string
Example
013xrzp12g3nqk8ns6jadrqmpgrjkeny
agent_id
Agent_Id

A valid agent ID

string
Example
013xrzp12g3nqk8ns6jadrqmpgrjkeny
agent_version_id
AgentVersion_Id

A valid agent version ID

string
Example
013xrzp12g3nqk8ns6jadrqmpgrjkeny
environment_id
Environment_Id

A valid environment ID

string
Example
013xrzp12g3nqk8ns6jadrqmpgrjkeny
finished_at
One of:

When the agent instance finished (null if still in progress)

string format: date-time
Example
2024-01-01T00:00:00Z
id
AgentInstance_Id

A valid agent instance ID

string
Example
013xrzp12g3nqk8ns6jadrqmpgrjkeny
inserted_at

When the agent instance was created

string format: date-time
Example
2024-01-01T00:00:00Z
peak_classification
One of:

Peak observed data risk classification across all spans in this instance. null if no spans have executed.

string
Allowed values: unknown public internal confidential restricted secret
Example
confidential
started_at
One of:

When the agent instance started (null if not started yet)

string format: date-time
Example
2024-01-01T00:00:00Z
status

Status of the agent instance: ‘pending’ (not started yet), ‘active’ (started but not finished), ‘complete’ (finished successfully), ‘failed’ (ended with failure), ‘cancelled’ (never started, cancelled), or ‘terminated’ (externally terminated)

string
Allowed values: pending active complete failed cancelled terminated
Example
active
termination_reason
One of:

Reason for termination (only present when status is ‘terminated’)

string
Example
User requested termination
type

Type of resource (always ‘agent_instance’)

string
Allowed values: agent_instance
Example
agent_instance
updated_at

When the agent instance was last updated

string format: date-time
Example
2024-01-01T00:00:00Z

default

Section titled “default ”

Error

One of:
object
code
string
Allowed values: bad_request bad_authtoken not_authenticated not_permitted not_implemented unknown not_found unexpected_ref_type unexpected invalid_action invalid_value required_value idempotency_key_already_used
Example
bad_request
message
string
status
string
Allowed values: error
Example
error