Salesforce B2C Commerce 24.7 > Developing Your Site > On-Demand Sandboxes

Use the Sandbox API to Manage On-Demand Sandboxes

Use the Sandbox API to create and manage on-demand sandboxes.

  • Access the Sandbox API
    You can access documentation for the Sandbox API and issue API calls from the Sandbox API user interface.
  • Get the On-Demand Sandbox ID
    Many of the Sandbox API calls require you to provide a sandbox’s ID. Get the ID using the GET/sandboxes method.
  • Assign Profiles to Define Sandbox Resources
    Manage your sandboxes more efficiently by assigning resource profiles to them based on your needs. Resource profiles define the disk, CPU, and memory allocation for their assigned sandboxes.
  • Check the Status of a Sandbox
    To check a sandbox’s status use the GET/sandboxes/{sandboxId} method.
  • Create an Operation Scheduler for On-Demand Sandboxes
    You can configure when to start and stop sandboxes to better manage on-demand sandbox usage. For example, with an Operation Scheduler, you can turn sandboxes on or off at specific times on specified weekdays. You can set a schedule for a realm or for a specific sandbox.
  • Start, Stop, Reset (DBINIT), and Restart an On-Demand Sandbox
    To stop, start, or reset (DBINIT) a sandbox, use the POST/sandboxes/{sandboxId}/operations method. Stopped sandboxes consume fewer credits than running sandboxes.
  • Allowlist On-Demand Sandbox IP Addresses
    You currently do not have to allowlist On-Demand Sandbox IP addresses to gain access to them. However, you might need to allowlist On-Demand Sandbox IP addresses on other systems or firewalls to communicate with On-Demand Sandboxes.
  • Use an Alias for an On-Demand Sandbox
    You can test storefronts by reusing a hostname alias for multiple sandboxes, or you can create a hostname alias that is unique to one sandbox.
  • Delete an On-Demand Sandbox
    To delete a sandbox, use the DELETE/sandboxes/{sandboxId} method. You can save credits by deleting a sandbox when you don’t need it anymore.
  • Check On-Demand Sandbox Credits
    To check the status of credits on the realm, use the GET/realm/{realm}/usage method. To check the status of credits for a specific sandbox, use the GET/sandboxes/{sandboxId}/usage method.

Infocenter Retirement: On June 30, 2023, the Infocenter was retired, and documentation currently hosted on the Infocenter will be published to Salesforce Help, Commerce Cloud Developer Center, and Salesforce B2C Commerce Developer Documentation Resources. For more information, see the release note.