Skip to main content

createTerminationRequest

client.swarm.createTerminationRequest(swarmId: string, data: CreateTerminationRequestBody): Promise<unknown>

Create a termination request for a swarm.

Submits a request to terminate specific agent instances within the swarm. This is used to reduce swarm size or remove specific agents.

Parameters​

ParameterTypeRequiredDescription
swarmIdstringYesThe unique identifier of the swarm
dataCreateTerminationRequestBodyYesThe termination request details

Returns​

Promise<unknown> — A promise that resolves to the created termination request

Example​

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

const client = new CodeBoltClient();

const result = await client.swarm.createTerminationRequest('swarmId', /* CreateTerminationRequestBody */);
console.log(result);