HomeGuides & tutorialsAPI reference
API reference
Back to Phantombuster.com →

/agents/stop

post
https://api.phantombuster.com/api/v2/agents/stop

Stops an agent.

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

Id of the agent to stop.

boolean

If true, tries to softly abort the agent.

boolean

If true, slave agents will recursively be stopped (even nested slaves).

boolean

If true, disables the next scheduled "launch soon" of the agent.

boolean

If true, the agent will switch to manual launch.

Headers
string

ID of the org that is perfoming the operation (not necessary when using a third party key)

Responses
200

Agent stopped successfully.

400

No agent exists with the provided id.

Updated over 2 years ago

Language
Credentials
Header
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here!

Updated over 2 years ago