Turn off the change agent of a pull request or a revision

Turns the change's agent off: it stops any work in progress, and every later event for the change is refused with change_agent_closed until POST /changeValidation/reset deletes the agent. Its status can still be read. The caller must be a person or a workspace API key that could have created the agent, one that can do everything the agent does; a person must hold a role in the workspace. Turning off an agent that is already off succeeds again. Branch on error_code in an error body: invalid_request (400), principal_too_narrow (403), and no_change_agent (404).

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params

The change whose agent to turn off or reset.

string
required

The workspace the change agent runs in

reference
object
required

The pull request or the revision, as the stage requests name it

Responses
204

The agent is off

Language
Credentials
:
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json