POST /agents/stop — phantombuster-api-v2

agents

Stops an agent.

post/agents/stop

Headers

X-Phantombuster-Orgstring

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

idstring required

Id of the agent to stop.

softAbortboolean

If true, tries to softly abort the agent.

cascadeToAllSlavesboolean

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

dontLaunchSoonboolean

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

switchToManualLaunchboolean

If true, the agent will switch to manual launch.

Agent stopped successfully.

No recorded changes to this endpoint across all 1 revision of this API.