Skip to main content

getAgentList

codebolt.agent.getAgentsList(type: Agents): Promise<any>
Retrieves a list of agents based on the specified type.

Parameters

NameTypeDescription
typeAgentsThe type of agents to list (default is Agents.DOWNLOADED)

Returns:

 Promise<any>
A promise that resolves with the list of agents

Example​

// Example 1: Getting list of downloaded agents (default)
const downloadedAgents = await codebolt.agent.getAgentsList();
console.log("Downloaded Agents:", downloadedAgents);

// Example 2: Getting list of local agents
const localAgents = await codebolt.agent.getAgentsList(Agents.LOCAL);
console.log("LOCAL Agents:", localAgents);

// Example 3: Getting list of cloud agents
const cloudAgents = await codebolt.agent.getAgentsList(Agents.CLOUD);
console.log("CLOUD Agents:", cloudAgents);

// Example 4: Getting list of all agents
const allAgents = await codebolt.agent.getAgentsList(Agents.ALL);
console.log("ALL Agents:", allAgents);