Skip to main content

stop

client.actionBlocks.stop(data: StopActionBlockRequest): Promise<unknown>

Stops a currently running action block execution.

Sends a stop signal to the specified action block execution, causing it to terminate gracefully. Use this to cancel long-running or stuck executions.

Parameters

ParameterTypeRequiredDescription
dataStopActionBlockRequestYesThe stop request containing the execution identifier to halt

Returns

Promise<unknown> — A promise that resolves when the stop signal has been sent

Example

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

const client = new CodeBoltClient();

const result = await client.actionBlocks.stop(/* StopActionBlockRequest */);
console.log(result);