Skip to content

Add filtering option for listing sandboxes #532

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
mishushakov merged 10 commits into from
Mar 21, 2025
Merged

Add filtering option for listing sandboxes #532

Show file tree
Hide file tree
Changes from 4 commits
Commits
Show all changes
10 commits
Select commit Hold shift + click to select a range
16f03d1
Add filtering support to sandbox API list method
jakubno Jan 10, 2025
7be39a4
Update filter to metadata
jakubno Mar 20, 2025
634bd3d
Update docs
jakubno Mar 20, 2025
39c8e1e
Add changeset
jakubno Mar 20, 2025
348441b
Fix docstring
jakubno Mar 20, 2025
f88bb87
Add missing files
jakubno Mar 20, 2025
469e706
Add query as top level parameter
jakubno Mar 20, 2025
0725395
Update docs
jakubno Mar 20, 2025
5b670e7
Fix quote in docs
mishushakov Mar 21, 2025
505a53f
Remove unused import and update docstrings
mishushakov Mar 21, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions .changeset/tame-needles-fry.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
---
'@e2b/python-sdk': patch
'e2b': patch
---

Add filtering by metadata
4 changes: 3 additions & 1 deletion .gitignore
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -292,4 +292,6 @@ cython_debug/
# SDK reference artifacts
sdk_ref/
sdkRefRoutes.json
spec/openapi_generated.yml

# SDK Client generated spec
spec/openapi_generated.yml
7 changes: 2 additions & 5 deletions apps/web/src/app/(docs)/docs/sandbox/list/page.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -63,9 +63,6 @@ Running sandbox template id: 3e4rngfa34txe0gxc1zf


## Filtering sandboxes
<Note>
This feature is in a private beta.
</Note>

You can filter sandboxes by specifying <Link href="/docs/sandbox/metadata">Metadata</Link> key value pairs.
Specifying multiple key value pairs will return sandboxes that match all of them.
Expand All @@ -87,7 +84,7 @@ const sandbox = await Sandbox.create({

// List running sandboxes that has `userId` key with value `123` and `env` key with value `dev`.
const runningSandboxes = await Sandbox.list({
filters: { userId: '123', env: 'dev' } // $HighlightLine
metadata: { userId: '123', env: 'dev' } // $HighlightLine
})
```
```python
Expand All @@ -103,7 +100,7 @@ sandbox = Sandbox(
)

# List running sandboxes that has `userId` key with value `123` and `env` key with value `dev`.
running_sandboxes = Sandbox.list(filters={
running_sandboxes = Sandbox.list(metadata={
"userId": "123", "env": "dev" # $HighlightLine
})
```
Expand Down
Loading