Sign in
agents

Adds an agent to the launch queue.

post/agents/launch

Headers

X-Phantombuster-Orgstring

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

Request body

idstring required

Id of the agent to launch.

saveArgumentboolean

If true, argument will be saved as the default launch options for the agent.

saveArgumentsboolean

If true, argument will be saved as the default launch options for the agent.

manualLaunchboolean

If set, the agent will be considered as "launched manually".

maxInstanceCountnumber

If set, the agent will only be launched if the number of already running instances is below the specified number.

internalMetadataobject nullable

PhantomBuster-managed key-value pairs for internal container tagging.

userCustomMetadataobject nullable

User-defined key-value pairs for container tagging.

persistedVolumeKeystring nullable

Key identifying the persisted volume to attach to the launched container.

Response

Agent launched successfully.

Changes