Stop Agent
phantombuster.stop_agent
ActionBusiness appsconnection required
Calls the Phantombuster API with the connection's credentials.
Abort a Phantom that is currently running.
Connection
- Required
- Yes — the node will not save without one
- Auth type
- API key
- Providers
- Phantombuster
- Secret shape
- the API key, or {"api_key": "…"}
- Config it needs
- org_id, base_url
- Resolved by
- config.connection_id, else node.connection_id
Configuration
5 fields, 1 required. A dotted path is a nested object and name[] an array of objects — the editor renders the same tree.
| Field | Type | Required | Default | Constraints | Example |
|---|---|---|---|---|---|
agent_id The Phantom's numeric id, which its URL in the Phantombuster dashboard ends with. | string | Yes | — | — | 1234567890123456 |
soft_abort Ask the Phantom to stop cleanly rather than killing it outright. | boolean | No | false | — | — |
cascade_to_all_slaves Also stop every slave agent this Phantom launched, including nested ones. | boolean | No | false | — | — |
dont_launch_soon Cancel the Phantom's next queued 'launch soon' as well as this run. | boolean | No | false | — | — |
switch_to_manual_launch Switch the Phantom to manual launching so its schedule stops firing. | boolean | No | false | — | — |
Example configuration
Every value below is the contract’s own example or default — nothing invented.
{
"agent_id": "1234567890123456",
"cascade_to_all_slaves": false,
"dont_launch_soon": false,
"soft_abort": false,
"switch_to_manual_launch": false
}Output
One shape.
result
| Field | Type | Example |
|---|---|---|
agent_id The Phantom that was asked to stop. | string | — |
stopped True once Phantombuster accepted the abort. | boolean | — |
response Phantombuster's own response body for this call, passed through unchanged. | object | — |
{
"agent_id": "",
"response": {},
"stopped": false
}Notes
- The org this acts for comes from the connection's optional org_id, sent as the X-Phantombuster-Org header; leave it unset when the key already names one org.
Related Phantombuster nodes
See Stop Agent run in a workflow.
In a technical demo we add the Phantombuster connection, drop the node on the canvas and let Workflow Health pre-flight it before the first real run.