Skip to main content

Ask the agent to do something

POST 

/api/v1/connectors/:connector_id/agent/commands

check_now (a poll now), readiness (regenerate the report), diagnostics (zip and upload logs and status, no secrets), update (install the channel's latest release; params gets its version, url and sha256), rotate_key, disable (stop sending and importing, keep heartbeating; the connector's status becomes disabled at once and PATCH /connectors/{id} with status: active re-enables it). The agent picks it up in its next heartbeat, normally within a minute. A pending command of the same type is replaced (cancelled). 409 AGENT_NOT_ENROLLED before any agent has enrolled; 409 RELEASE_NOT_PUBLISHED for update with nothing to install.

Requestโ€‹

Responsesโ€‹

Successful Response