Skip to main content
Sandbox metadata lets you attach custom key-value information to a sandbox. Common uses include:
  • Connecting a sandbox to a user session.
  • Saving custom user-related data for a sandbox, such as API keys.
  • Linking a sandbox to a user ID so it can be reconnected later.
Metadata is provided when the sandbox is created. Later, it can be read when listing active sandboxes with Sandbox.list().

Metadata-based filtering

Sandboxes can also be filtered using metadata when listing.
Last modified on June 4, 2026