Salesforce B2C Commerce 24.5 > Developing Your Site > On-Demand Sandboxes > Use the Sandbox API to Manage On-Demand Sandboxes

Create an Operation Scheduler for On-Demand Sandboxes

⚠️ The annual cost of maintaining the server where this website is hosted, the domain, and keeping it up-to-date is approximately €3,000 per year. Help us with a small donation to cover these expenses. Support Now!

0 / 10000 €

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.

When creating an Operation Scheduler, keep these considerations in mind:

For the scheduler to manage an on-demand sandbox, you must set the sandbox autoScheduled parameter to true.
If schedule is configured for a realm but not a Sandbox, and the autoScheduled parameter is set to true, the Sandbox uses the schedule configured in the realm.
If the schedule is configured for a Sandbox, the priority is given to the sandbox. The schedule configuration from the realm isn't used.
Scheduler times use Zulu (Coordinated Universal Time) or Greenwich Mean Time (+offset) format.
Default Operation Scheduler settings turn all auto-scheduled sandboxes on Monday through Friday at 08:00:00+03:00 and off on the same weekdays at 19:00:00Z.
Set start and stop schedules at least 10 minutes apart. If the startScheduler and stopScheduler difference is less than 10 minutes in the same day, and time combination, the API returns an error.
To turn off the scheduler, set the startScheduler and stopScheduler parameters to null. For example:

Create an Operation Scheduler using the PATCH/realms/{realm}/configuration, POST/sandboxes or PATCH /sandboxes/{sandboxId} method.

To open the Sandbox API user interface, go to B2C Commerce Sandbox API.
Click Authorize.
Enter the API client ID for the Sandbox API.
To dismiss the authorization window and return to the Sandbox API user interface, click Close.
(Optional) In the Realms section of the Sandbox API user interface, click to expand the PATCH/realms/{realm}/configuration method.
(Optional) In the Sandbox section of the Sandbox API user interface, click to expand the POST/sandboxes method.
(Optional) To update an operation scheduled, In the Sandbox section of the Sandbox API user interface, click to expand the PATCH /sandboxes/{sandboxId} method.
Click Try it out.
In the request body, modify the startScheduler and stopScheduler weekdays and times to when you want to start and stop auto-scheduled sandboxes.
Specify the four-letter ID for the realm.
Click Execute.
The API creates an Operation Scheduler that manages all sandboxes in the realm with their autoScheduled parameter set to true.