Skip to main content

getConfig

client.swarm.getConfig(swarmId: string): Promise<SwarmConfig>

Get the configuration of a swarm.

Retrieves the current configuration settings for a swarm, including operational parameters, limits, and behavioral settings. Use this to view swarm settings or for configuration management.

Parameters​

ParameterTypeRequiredDescription
swarmIdstringYesThe unique identifier of the swarm

Returns​

Promise<SwarmConfig> — A promise that resolves to the SwarmConfig object

Example​

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

const client = new CodeBoltClient();

const result = await client.swarm.getConfig('swarmId');
console.log(result);