Skip to main content

deleteSwarm

client.swarm.deleteSwarm(swarmId: string): Promise<void>

Delete a swarm by ID.

Permanently removes a swarm and all its associated resources including teams, roles, agents, and configurations. This action cannot be undone.

Parameters​

ParameterTypeRequiredDescription
swarmIdstringYesThe unique identifier of the swarm to delete

Returns​

Promise<void> — A promise that resolves when the swarm is deleted

Example​

import { CodeBoltClient } from '@codebolt/clientsdk';

const client = new CodeBoltClient();

const result = await client.swarm.deleteSwarm('swarmId');
console.log(result);