Sign in

v1

latestOpenAPI 3.0.0ISC2026-07-26782347.5 KB
agents

Gets an agent by id.

get/agents/fetch

Query parameters

idstring required

Id of the agent to fetch.

withManifeststring

Set to "true" if you want to return the agent's manifest in the response

withAgentObjectstring

Set to "true" if you want to include the agent_object in the response

withCodestring

Set to "true" if you want to include the agent's script code in the response

withSlavesstring

Set to "true" if you want to include the agent's slave agents in the response

withSubSlavesstring

Set to "true" if you want to include the agent's sub-slave agents in the response (requires withSlaves=true)

Headers

X-Phantombuster-Orgstring

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

Response

OK

idstring required
scriptOrgNamestring nullable
scriptIdstring nullable
scriptstring nullable
branchstring nullable
environment'staging' | 'release' nullable
argumentstring nullable
lastEndType'finished' | 'killed' | 'global timeout' | 'org timeout' | 'agent timeout' | 'unknown' | 'no log timeout' nullable
codestring nullable
namestring nullable
executionTimeLimitnumber nullable
fileMgmt'folders' | 'mix' | 'delete' required
fileMgmtMaxFoldersnumber nullable
maxParallelismnumber nullable
maxRetryNumbernumber nullable
proxyType'none' | 'http' | 'pool' | 'squid lease'
proxyAddressstring nullable
proxyUsernamestring nullable
proxyPasswordstring nullable
launchType'manually' | 'repeatedly' | 'once' | 'after agent' required
lastNonManualLaunchType'manually' | 'repeatedly' | 'once' | 'after agent' nullable
launchOnceAtnumber nullable
launchAfterAgentIdstring nullable
nbLaunchesnumber required
s3Folderstring required
orgS3Folderstring required
agentObjectstring nullable
slaveSlugstring nullable
masterAgentIdstring nullable
launchBeforenumber nullable
masterAgentLaunchAfternumber nullable
persistedVolumeKeystring nullable
wasSetupValidWhenSubmittedByTheFrontendboolean
updatedAtnumber required
expireAtnumber nullable
internalMetadataobject nullable
userCustomMetadataobject nullable