agentRunner

Stop an agent run

Changed on

Stops the run's active session. Stopping happens in the background.

post/agent_runners/{agent_runner_id}/stop

Request

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

Response

Accepted. The response has no body. The run's active sessions are set to cancelled before this 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