hiddenAgentRunner

Stop an agent run (alias)

Changed on

Same as POST /agent_runners/{agent_runner_id}/stop. Doesn't delete the run.

delete/agent_runners/{agent_runner_id}

Request

  • Base URL
    https://api.netlify.com/api/v1
  • URL
    https://api.netlify.com/api/v1/agent_runners/{agent_runner_id}
  • Auth
    OAuth 2
    Implicit: https://app.netlify.com/authorize

Response

Accepted. Same behavior as stopAgentRunner: the response has no body, the run's active sessions are set to cancelled before it returns, and the sandbox shuts down in the background. To confirm, poll getAgentRunnerSession (GET /agent_runners/{agent_runner_id}/sessions/{agent_runner_session_id}) and check that state is cancelled.

Changes