Skip to main content

update

client.orchestrator.update(id: string, data: UpdateOrchestratorRequest): Promise<OrchestratorInstance>

Updates an existing orchestrator instance's configuration.

Modifies the settings, rules, or agent assignments of an orchestrator. Changes take effect for subsequent workflow executions.

Parameters

ParameterTypeRequiredDescription
idstringYesThe unique identifier of the orchestrator to update
dataUpdateOrchestratorRequestYesThe fields to update on the orchestrator

Returns

Promise<OrchestratorInstance> — A promise that resolves to the updated orchestrator instance

Example

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

const client = new CodeBoltClient();

const result = await client.orchestrator.update('id', /* UpdateOrchestratorRequest */);
console.log(result);