Skip to main content
POST
Archive an agent

Authorizations

Authorization
string
header
required

An Egma API key.

Path Parameters

agentId
string
required

The Egma agent ID returned by Register an agent or List agents.

Minimum string length: 1
Example:

"agt_01M0E4J0BBE1FVDVTZ1BSS5C97"

Query Parameters

projectId
string

Project to act in. A project-scoped API key already identifies its project.

Minimum string length: 1

Body

application/json

The body is of type object.

Response

The archived agent and the work stopped with it.

agent
object
required
archivedConnections
string[]
required
Minimum string length: 1
canceledRunCount
integer
required
Required range: x >= 0