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

Function: createDeployment()

createDeployment(options, auth): Promise<CreateDeploymentResult>

Defined in: packages/b2c-tooling-sdk/src/operations/mrt/deployment.ts:221

Deploys a bundle to an MRT environment.

This endpoint is asynchronous - the deployment will happen in the background. Request the target for progress updates.

Parameters

options

CreateDeploymentOptions

Deployment options

auth

AuthStrategy

Authentication strategy (ApiKeyStrategy)

Returns

Promise<CreateDeploymentResult>

Initial deployment status

Throws

Error if request fails

Example

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

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

const result = await createDeployment({
  projectSlug: 'my-storefront',
  targetSlug: 'staging',
  bundleId: 12345
}, auth);

console.log(`Deployment started: ${result.status}`);