Skip to main content

listEnvironments

client.environments.listEnvironments(params?: Record<string, unknown>): Promise<Environment[]>

Lists all environments.

Returns every environment regardless of state. Use optional parameters to filter or paginate the results.

Parameters

ParameterTypeRequiredDescription
paramsRecord<string, unknown>NoOptional query parameters for filtering or pagination

Returns

Promise<Environment[]> — A promise that resolves to an array of objects

Example

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

const client = new CodeBoltClient();

const result = await client.environments.listEnvironments();
console.log(result);