ENentire
Project Agents

Archive an agent

Changed on

Archiving cancels the agent's queued and running runs. Restore it under the same id.

post/api/v1/{forge}/{project}/agents/{id}/archive

Request

  • Base URL
    https://entire.io (the document declares no server; this is the origin it was published from)
  • URL
    https://entire.io/api/v1/{forge}/{project}/agents/{id}/archive
  • Auth
    none declared. Required headers: If-Match

Path parameters

forge'gh' | 'et' required
projectstring required
idstring required

Headers

If-Matchstring required

The JSON etag of the last read or write.

Response

The archived agent

idstring required
project_idstring required
versioninteger required
etagstring required

Write token: send it unchanged as If-Match to replace or archive.

created_atstring required
updated_atstring required
archived_atstring nullable required
namestring required
descriptionstring required
harnessstring required
modelstring nullable required
reasoning_effortstring nullable required
timeout_msinteger required
instructionsstring required
is_enabledboolean required

Whether its trigger runs it. A paused agent still runs when asked to.

environment_idstring required
repository_idsstring[] required
stale_repository_idsstring[] required

Changes

  • f4a534501f84Revision changes
    • info

      added the required property // to the response with the status

    • info

      added the required property // to the response with the status

  • e8893f80c9f2Revision changes
    • info

      added the required property // to the response with the status