Skip to content
Docs

list_named_sandboxes

List named sandboxes for a project. This tool corresponds to the listNamedSandboxes catalog operation. Use list_sessions to list Sandbox sessions.

ParameterTypeRequiredDescription
projectstringYesThe unique identifier or name of the project to list named sandboxes for.
limitnumberNoMaximum number of named sandboxes to return in the response. Used for pagination. Minimum: 1. Maximum: 50. Default: 20.
sortBystringNoField to sort by. Allowed values: "createdAt", "name", "statusUpdatedAt", "currentSnapshotId". Default: "createdAt".
namePrefixstringNoFilter named sandboxes whose name starts with this prefix. Only valid when sortBy=name.
cursorstringNoOpaque pagination cursor from a previous response.
sortOrderstringNoSort direction. Allowed values: "asc", "desc". Default: "desc".
statusstringNoFilter named sandboxes by status. Only valid when sortBy is createdAt. Allowed values: "running", "stopping", "stopped".
tagsstring | Array<string>NoFilter sandboxes by tag. Format: "key:value". Only one tag filter is supported at a time.
teamIdstringNoTeam ID to use for this operation.
slugstringNoTeam slug to use for this operation. Use instead of teamId.

Was this helpful?

supported.