Skip to main content

stopProvider

client.environments.stopProvider(id: string, data?: Record<string, unknown>): Promise<unknown>

Stops the underlying provider for an environment.

Shuts down the provider process without destroying the environment. The provider can be restarted later.

Parameters

ParameterTypeRequiredDescription
idstringYesThe unique identifier of the environment
dataRecord<string, unknown>NoOptional stop configuration

Returns

Promise<unknown> — A promise that resolves when the provider has stopped

Example

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

const client = new CodeBoltClient();

const result = await client.environments.stopProvider('id');
console.log(result);