Skip to main content

startEnvironment

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

Starts an environment.

Boots up the environment so it becomes active and ready for use. The environment's provider must be running first.

Parameters​

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

Returns​

Promise<unknown> — A promise that resolves when the environment has started

Example​

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

const client = new CodeBoltClient();

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