Skip to main content
Manage sandbox images For a detailed overview, please visit the sandbox image’s reference page. Refer to the sandbox images guide for additional details.

sandboximage access-report

Show the access report for the referenced sandbox image Usage
Common Options Reference

sandboximage audit

Retrieve audit trail events for the referenced sandbox image Usage
Common Options Reference
  • Show the audit trail events of a sandbox image from the last 7 days (the default)
  • Show the audit trail events of a sandbox image from the last 24 hours

sandboximage buildlog

Print the referenced sandbox image’s latest build log Usage
Common Options Reference
  • Print the log of the latest build as read so far
  • Keep reading the log until the build ends

sandboximage clone

Create a copy of the referenced sandbox image; the copy builds under your token Usage
Common Options Reference

sandboximage create

Create a sandbox image and submit its build Usage
The command returns as soon as the build is submitted. Follow the build with sandboximage buildlog, and read its phase with sandboximage get.
--type dev, the default, builds an image for dev sandboxes. --type agent builds an image for sessions and needs --base-image.
Common Options Reference
  • Create a dev sandbox image on the standard sandbox base
  • Create a dev sandbox image on an image of the org, and tag the built image v1
  • Create an agent sandbox image, for sessions

sandboximage delete

Delete one or more referenced sandbox images Usage
Common Options Reference

sandboximage edit

Edit the referenced sandbox image, as YAML, within an editor Usage
The default editor can be set by using the EDITOR environment variable.
Common Options Reference

sandboximage eventlog

Show the event log of the referenced sandbox image Usage
Common Options Reference

sandboximage get

Retrieve one or more referenced sandbox images Usage
An empty reference will return all references
Common Options Reference
  • Get all sandbox images
  • Get one sandbox image

sandboximage patch

Update the referenced sandbox image’s metadata using an input file Usage
Running this command with the option --file - sets the input to stdin. The input is required to be a valid JSON or YAML string (e.g., {"description": "My new description"} or description: My new description). To complete the update, press Control-D (or Control-Z if you are using Windows).
Common Options Reference

sandboximage permissions

Show the grantable permissions for a sandbox image object type Usage
Common Options Reference

sandboximage query

Find all the sandbox images based on the given query Usage
Common Options Reference
Use the --match option to display all, none, or any of the results based on a given property or tag
  • Search for a sandbox image based on the name property
  • Search for the sandbox images whose latest build is ready

sandboximage rebuild

Rebuild one or more referenced sandbox images from their current recipe Usage
Common Options Reference

sandboximage tag

Manage the tags belonging to one or more referenced sandbox images Usage
Built-in tags, which begin with cpln/*, can’t be modified.
Common Options Reference
  • Add a tag
  • Remove tag (after running the example above)

sandboximage update

Update properties of the referenced sandbox image Usage
A change to a property under spec submits a new build of the sandbox image.
Common Options Reference
  • The --set option allows the modification of the following sandbox image properties:
    • description
      • Description of the sandbox image
      • Type: string
    • tags
      • Tags (key=value) associated with the sandbox image
      • Type: string
    • spec.base.image
      • The image the sandbox layer is built onto: a link to an org image (//image/NAME:TAG) or a full image reference
      • Type: string
    • spec.tag
      • The tag of the built image in the org registry
      • Default: latest
      • Type: string
    • spec.type
      • The type of the sandbox image
      • Choices: dev, agent
      • Default: dev
      • Type: string
  • Update a sandbox image’s description
  • Update a sandbox image’s base image, which submits a new build