Skip to content
Prefactor Docs

Fetch agent deployment

GET
/api/v1/agent_deployment/{agent_deployment_id}

Authorizations

Section titled “Authorizations ”

Parameters

Section titled “ Parameters ”

Path Parameters

Section titled “Path Parameters ”
agent_deployment_id
required
AgentDeployment_Id

A valid agent deployment ID

string
Example
013xrzp12g3nqk8ns6jadrqmpgrjkeny

Query Parameters

Section titled “Query Parameters ”
idempotency_key
One of:

Optional idempotency key for ensuring request idempotency

string

Responses

Section titled “ Responses ”

200

Section titled “200 ”

Success

object
details
AgentDeployment_Details
object
account_id
Account_Id

A valid account ID

string
Example
013xrzp12g3nqk8ns6jadrqmpgrjkeny
agent_id
Agent_Id

A valid agent ID

string
Example
013xrzp12g3nqk8ns6jadrqmpgrjkeny
current_version_id
One of:
AgentVersion_Id

A valid agent version ID

string
Example
013xrzp12g3nqk8ns6jadrqmpgrjkeny
environment_id
Environment_Id

A valid environment ID

string
Example
013xrzp12g3nqk8ns6jadrqmpgrjkeny
id
AgentDeployment_Id

A valid agent deployment ID

string
Example
013xrzp12g3nqk8ns6jadrqmpgrjkeny
inserted_at

When the deployment was created

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

Type of resource (always ‘agent_deployment’)

string
Allowed values: agent_deployment
Example
agent_deployment
updated_at

When the deployment 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