Skip to content

docs(sandboxes): show how to recover an existing sandbox #26226

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

Open
nielskaspers wants to merge 1 commit into
base: main
Choose a base branch
from
Open

docs(sandboxes): show how to recover an existing sandbox #26226

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
14 changes: 12 additions & 2 deletions content/manuals/ai/sandboxes-api/get-started.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -111,8 +111,18 @@ For CI jobs and other unattended applications, use
[PAT authentication](authentication.md#authenticate-automation-with-a-pat).

If the program stops after printing the sandbox name, retrieve the sandbox
with `client.get(name)` and delete it when you're finished. Closing the client
doesn't delete the sandbox.
with `client.get(name)` and delete it when you're finished. The `name` value is
the full resource name printed by the program, such as
`sandboxes/<uid>`:

```typescript
const existing = await client.get(name);
const latest = await existing.refresh();
const deleting = await latest.delete({ force: true });
await deleting?.waitUntilDeleted();
```

Closing the client doesn't delete the sandbox.

## Next steps

Expand Down
Loading