Skip to content
Prefactor Docs

Fetch agent

GET
/api/v1/agent/{agent_id}

Authorizations

Section titled “Authorizations ”

Parameters

Section titled “ Parameters ”

Path Parameters

Section titled “Path Parameters ”
agent_id
required
Agent_Id

A valid agent ID

string
Example
013xrzp12g3nqk8ns6jadrqmpgrjkeny

Query Parameters

Section titled “Query Parameters ”
idempotency_key
One of:

Optional idempotency key for ensuring request idempotency

string
environment_id
One of:
Environment_Id

A valid environment ID

string
Example
013xrzp12g3nqk8ns6jadrqmpgrjkeny
include_counts

Include instance counts in the response

boolean
include_risk_rollup

Include risk rollup (theoretical and observed risk) in the response

boolean

Responses

Section titled “ Responses ”

200

Section titled “200 ”

Success

Agent_GetDetailsOutput
object
details
Agent_Details
object
available_actions
Agent_AvailableActions

Available actions for this agent based on its status and instance counts

object
delete

Whether the agent can be deleted

boolean
reinstate

Whether the agent can be reinstated from retired

boolean
retire

Whether the agent can be retired

boolean
update

Whether the agent can be updated

boolean
description
One of:

Agent description

string
Example
Agent description
id
Agent_Id

A valid agent ID

string
Example
013xrzp12g3nqk8ns6jadrqmpgrjkeny
inserted_at

When the agent was created

string format: date-time
Example
2024-01-01T00:00:00Z
instance_counts
Agent_InstanceCounts
object
active

Number of instances with status active (running)

integer
Example
2
cancelled

Number of instances with status cancelled

integer
0
complete

Number of instances with status complete

integer
Example
5
failed

Number of instances with status failed

integer
0
finished

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

integer
Example
5
pending

Number of instances with status pending

integer
0
terminated

Number of instances with status terminated

integer
0
total

Total number of agent instances

integer
Example
10
name

Agent name

string
Example
My Agent
risk_profile_id
One of:
RiskProfile_Id

A valid risk profile ID

string
Example
013xrzp12g3nqk8ns6jadrqmpgrjkeny
status

Agent status

string
Allowed values: pending active dormant retired
Example
pending
type

Type of resource (always ‘agent’)

string
Allowed values: agent
Example
agent
updated_at

When the agent was last updated

string format: date-time
Example
2024-01-01T00:00:00Z
risk_rollup
One of:
Agent_RiskRollup
object
observed_risk
One of:
Agent_RiskSummary
object
all_data_categories

List of all data categories included across span types

Array<string>
<= 18 items
assessed_span_types

Number of span types with risk data

integer
classification_counts

Count of span types at each classification level

object
confidential
integer
internal
integer
public
integer
restricted
integer
secret
integer
unknown
integer
external_communication_count

Number of span types with external communication allowed

integer
highest_classification

Highest classification level across all span types

string
Allowed values: unknown public internal confidential restricted secret
Example
unknown
total_span_types

Total number of span types

integer
unassessed_span_types

Number of span types without risk data

integer
theoretical_risk
One of:
Agent_RiskSummary
object
all_data_categories

List of all data categories included across span types

Array<string>
<= 18 items
assessed_span_types

Number of span types with risk data

integer
classification_counts

Count of span types at each classification level

object
confidential
integer
internal
integer
public
integer
restricted
integer
secret
integer
unknown
integer
external_communication_count

Number of span types with external communication allowed

integer
highest_classification

Highest classification level across all span types

string
Allowed values: unknown public internal confidential restricted secret
Example
unknown
total_span_types

Total number of span types

integer
unassessed_span_types

Number of span types without risk data

integer
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