agents

Update an Agent resource.

Changed on

Updates mutable Agent fields for an existing Agent. The agent name in the path identifies the Agent and is immutable.

put/api/agent/{agentName}

Request

  • Base URL: / (relative, and the document was published on a file host, not at the API’s origin)
  • URL: /api/agent/{agentName}
  • Auth: HTTP bearer

Path parameters

agentNamestring required

Agent name.

Request body

envobject

Response

Agent resource updated.

namestring required
last_activitystring date-time required
created_atstring date-time required
modified_atstring date-time required
status'UNSPECIFIED' | 'PROGRESSING' | 'DEGRADED' | 'DELETED' | 'IDLE' required

Changes

    • breaking

      the / request property format changed from no format to markdown

    • info

      the / request property's maxLength was increased from 4096 to 32000

    • info

      added the optional property to the response with the status

    • info

      added the non-success response with the status