Replace an agent

PUT 
/agent/:id

Replaces the agent's name, description and config (send them all). agent_type and endpoint are copied from config.connection and cannot be set directly. Credentials are never stored with the agent: config.connection.api_key must be a ${VARIABLE} reference to an organization secret (see POST /secret), and a literal credential anywhere in config is refused with 400. Runs already launched keep the configuration they were launched with.

Request

Responses

200

OK

400

Validation error: the request is invalid and nothing was changed.

401

Missing, invalid, expired or revoked credential, or a credential this endpoint does not accept.

403

The credential may not do this (for example a run token outside its own run, or a caller without an organization), or the installation is read-only because its license is not valid (code: license_read_only).

404

Not found: no such object in the caller's organization.

429

Rate limited: retry after the number of seconds in the Retry-After header.