Skip to content
Prefactor Docs

Finish an agent instance

POST
/api/v1/agent_instance/{agent_instance_id}/finish

Authorizations

Section titled “Authorizations ”

Parameters

Section titled “ Parameters ”

Path Parameters

Section titled “Path Parameters ”
agent_instance_id
required
AgentInstance_Id

A valid agent instance ID

string
Example
013xrzp12g3nqk8n4evtrcj59k8dhn3t

Request Body

Section titled “Request Body ”

Terminal status: ‘complete’ (default), ‘failed’, or ‘cancelled’. When ‘cancelled’, instance must be pending and both timestamps are set to the (optional) timestamp.

string
Allowed values: complete failed cancelled
Example
complete

Responses

Section titled “ Responses ”

200

Section titled “200 ”

Success

object
details
AgentInstance_Details
object
account_id
Account_Id

A valid account ID

string
Example
013xrzp12g3nqk8ngskn1wtxgka5b0nf
agent_id
Agent_Id

A valid agent ID

string
Example
013xrzp12g3nqk8nx0y2vfkg4s3jp2qr
agent_version_id
AgentVersion_Id

A valid agent version ID

string
Example
013xrzp12g3nqk8n6mv28ge2v9f7n2hc
environment_id
Environment_Id

A valid environment ID

string
Example
013xrzp12g3nqk8nzxvq7jm2arsfg5h1
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
013xrzp12g3nqk8n4evtrcj59k8dhn3t
inserted_at

When the agent instance was created

string format: date-time
Example
2024-01-01T00:00:00Z
span_counts
AgentInstance_SpanCounts
object
active

Number of spans with status active (running)

integer
Example
2
cancelled

Number of spans with status cancelled

integer
0
complete

Number of spans with status complete

integer
Example
5
failed

Number of spans with status failed

integer
0
finished

Number of spans in a finished state (complete + failed + cancelled)

integer
Example
5
pending

Number of spans with status pending

integer
0
total

Total number of agent spans

integer
Example
10
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), or ‘cancelled’ (never started, cancelled)

string
Allowed values: pending active complete failed cancelled
Example
active
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
status
string
Allowed values: success
Example
success

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