Skip to Content

On-Demand Sandboxes

Create, start, stop, reset and delete realm sandboxes from the B2C ODS tool window

The B2C ODS tool window, at the bottom of the IDE, manages the on-demand sandboxes of your realms through the Salesforce ODS API. It uses an API client, not a project connection

B2C ODS lists the realm's sandboxes with their state, profile and owner. States and counters refresh on their own every 10 seconds, and Start, Stop and Restart turn on only when a selected sandbox can take them

Add a configuration

A configuration is one API client on one API server. Each configuration gets its own tab

A configuration pairs an OCAPI client from B2C Credentials with an API server. Get Token and Save checks the client before the tab opens, a double-click renames the tab and closing it asks first

Prepare the API client

In Account Manager, give your API client access to the sandbox API for your realm. Then add it on the API Clients tab of B2C Credentials

Create the tab

Open B2C ODS (View › Tool Windows, or More › Tool Windows). With no configuration yet it shows "No On-Demand Sandboxes Configurations". Click + (Add On-Demand Sandboxes Configuration)

Fill in the dialog

Enter a Name, pick the Api Server and select the OCAPI Credentials, then click Get Token and Save. The tab opens with the realm's sandboxes

The Api Server list has four hosts:

  • https://admin.dx.commercecloud.salesforce.com (default)
  • https://admin.us01.dx.commercecloud.salesforce.com
  • https://admin.us02.dx.commercecloud.salesforce.com
  • https://admin.us03.dx.commercecloud.salesforce.com

Double-click a tab to rename it. Closing a tab removes the configuration after a confirmation. Edit Configuration in the toolbar opens the same dialog, with the credentials locked

Sandboxes table

Refresh Sandboxes reloads the whole table under a progress stripe. Auto refresh replaces only the rows whose state changed, and typing in the table jumps to the matching sandbox
ColumnShows
[Name] HostnameThe sandbox hostname, with your custom name in brackets
StateFor example started, stopped, starting or stopping
RealmThe realm ID
Resource ProfileMedium, Large or XLarge
Created ByWho created the sandbox

The toolbar shows Total, Started and Stopped counters, plus Selected while rows are selected. States are coloured: started green, stopped red, starting cyan, new and creating orange

Refresh Sandboxes reloads the whole table under a progress stripe. With auto refresh on, the table checks every 10 seconds and replaces only the rows whose state changed. Type while the table has focus to jump to the first matching sandbox

Start, stop and restart

Start runs right away. Stop, Restart, Reset and Delete ask first and list the hosts they touch, and a selection of several sandboxes runs them in parallel

Select rows and use Start Sandbox, Stop Sandbox or Restart Sandbox in the toolbar (for example "Start 3 Sandboxes" with several selected). Start runs right away. Stop, Restart, Reset and Delete ask first and list the hosts they touch

Each button is enabled only when a selected sandbox can take the action: Start needs one that is not started, Stop and Restart need one that is not stopped. Hold Cmd (Ctrl on Windows and Linux) to select several rows

Sandbox menu

Right-click a sandbox

Right-click a sandbox to name it, copy its ID, URLs or full JSON, open Business Manager, OCAPI, WebDAV, IMPEX or Logs in the browser, reset it or delete it
ItemWhat it does
Edit Custom NameSets a display name. Leave it empty to remove it
Start, Stop, RestartSame as the toolbar
Copy › ID, URL, Business Manager URL, Sandbox Data as JSONCopies the value
Open Links › Business Manager, OCAPI, WebDAV, IMPEX, LogsOpens the link in the browser
Reset Sandbox, Delete SandboxResets or deletes the sandbox after a confirmation

To work with a sandbox in the project, copy its URL and add it as a connection in Connections

Create a sandbox

Click Add Sandbox in the toolbar to open Create On-Demand Sandbox

Add Sandbox reads the realms your client can use. Pick a resource profile and a time to live in hours, then follow the new sandbox from new to started in the table
FieldDefaultNotes
RealmLoaded from the API ("Getting realms list...")
Resource ProfileMediumMedium, Large or XLarge. Larger profiles use more credits
Time to live (TTL)0Hours the sandbox lives, within your realm's quotas. 0 means it never expires

Click Create On-Demand Sandbox. The plugin confirms "The sandbox creation has started!" with the new hostname, then reloads the table. Leave auto refresh on to follow the sandbox from new to started

With an AI agent

An agent connected to B2C MCP can list your sandboxes, check a realm's limits and plan starting, stopping, adding hours or creating one. Each change runs as a plan with the tools you gave the agent, and a new sandbox always gets a time to live, see What Agents Can Do

Troubleshooting

MessageWhat to do
"Failed to get Access Token!"The client ID, secret or API server is wrong, or the client has no sandbox API access for the realm
Client Secret is EmptyEdit the API client in B2C Credentials and add its secret
A configuration for these credentials already existsEach API client can back one configuration. Use the existing tab
"Error occurred while getting realms"The client can't list realms. Check its realm access in Account Manager
Sandbox is down during uploadThe sandbox of the active connection is stopped. Start it here, then upload again

On this page