Change the sandbox name

Define a meaningful name for your sandbox to make it easily recognizable when returned in a list or in a log line.

Before you begin

This step assumes you are modifying an existing sandbox and know the sandboxID.

If you did not define a name when you first created the sandbox, the default is sandboxID, a randomly generated string. Follow these steps to create a more meaningful name for the sandbox.

How to

  1. Form a JSON request body and provide a value for the name.
  2. Issue a PUT request to /sandbox-api/v1/sandboxes/{sandboxId} to confirm the changes.
    You’ll get a 204 response confirming the sandbox has been updated with the changes.