Skip to content

docs(instance): change server terminate documentation #1457

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
merged 1 commit into from
Oct 3, 2024
Merged

docs(instance): change server terminate documentation #1457

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
15 changes: 7 additions & 8 deletions packages/clients/src/api/instance/v1/api.gen.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -458,15 +458,14 @@ export class API extends ParentAPI {
* and release the hypervisor slot. `stop_in_place`: Stop the Instance, but
* keep the slot on the hypervisor. `reboot`: Stop the instance and restart
* it. `backup`: Create an image with all the volumes of an Instance.
* `terminate`: Delete the Instance along with all attached volumes.
* `enable_routed_ip`: Migrate the Instance to the new network stack.
* `terminate`: Delete the Instance along with its attached volumes, except
* for SBS volumes. `enable_routed_ip`: Migrate the Instance to the new
* network stack.
*
* Keep in mind that terminating an Instance will result in the deletion of
* all attached volumes, including local and block storage. If you want to
* preserve your local volumes, you should use the `archive` action instead of
* `terminate`. Similarly, if you want to keep your block storage volumes, you
* must first detach them before issuing the `terminate` command. For more
* information, read the [Volumes](#path-volumes-list-volumes) documentation.
* Keep in mind that `terminate` an Instance will result in the deletion of
* `l_ssd`, `b_ssd` and `scratch` volumes types, `sbs_volume` volumes type
* will only be detached. If you want to preserve your volumes, you should
* detach them before the Instance deletion or `terminate` action.
*
* @param request - The request {@link ServerActionRequest}
* @returns A Promise of ServerActionResponse
Expand Down