Developer Preview — This project is in active development. APIs may change. Provide feedback
Skip to content

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

Function: listRedirects()

listRedirects(options, auth): Promise<ListRedirectsResult>

Defined in: packages/b2c-tooling-sdk/src/operations/mrt/redirect.ts:124

Lists redirects for an MRT environment.

Parameters

options

ListRedirectsOptions

List options

auth

AuthStrategy

Authentication strategy (ApiKeyStrategy)

Returns

Promise<ListRedirectsResult>

Paginated list of redirects

Throws

Error if request fails

Example

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

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

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

for (const redirect of result.redirects) {
  console.log(`${redirect.from_path} -> ${redirect.to_url}`);
}

Released under the Apache-2.0 License.