@salesforce/b2c-tooling-sdk / operations/mrt / listEnvs

Function: listEnvs()

listEnvs(options, auth): Promise<ListEnvsResult>

Defined in: packages/b2c-tooling-sdk/src/operations/mrt/env.ts:507

Lists environments (targets) for an MRT project.

Parameters

options

ListEnvsOptions

List options

auth

AuthStrategy

Authentication strategy (ApiKeyStrategy)

Returns

Promise<ListEnvsResult>

List of environments

Throws

Error if request fails

Example

import { ApiKeyStrategy } from '@salesforce/b2c-tooling-sdk/auth';
import { listEnvs } from '@salesforce/b2c-tooling-sdk/operations/mrt';

const auth = new ApiKeyStrategy(process.env.MRT_API_KEY!, 'Authorization');

const result = await listEnvs({ projectSlug: 'my-storefront' }, auth);
for (const env of result.environments) {
  console.log(`- ${env.name} (${env.slug}): ${env.state}`);
}