For AI agents: The documentation index is at https://docs.digitalocean.com/llms.txt. Markdown versions of pages use the same URL with index.html.md in place of the HTML page (for example, append index.html.md to the directory path instead of opening the HTML document).

Usage

client.v2.microvms.checkpoints.byCheckpoint_id(checkpoint_id).delete(requestConfiguration?: RequestConfiguration<object>): Promise<void>

Description

To delete a checkpoint, send a DELETE request to /v2/microvms/checkpoints/{checkpoint_id}. You can no longer create MicroVMs from a deleted checkpoint.

The request returns HTTP 400 while the checkpoint is still being captured. A successful request returns a 204 No Content status code.

Parameters

checkpoint_id string required

Example: 01a0ed98-0a74-75dd-a625-e4856adbc298

The unique ID of the checkpoint.

Request Sample

import { FetchRequestAdapter } from "@microsoft/kiota-http-fetchlibrary";
import {
    createDigitalOceanClient,
    DigitalOceanApiKeyAuthenticationProvider,
} from "@digitalocean/dots";

const authProvider = new DigitalOceanApiKeyAuthenticationProvider(process.env.DIGITALOCEAN_TOKEN!);
const adapter = new FetchRequestAdapter(authProvider);
const client = createDigitalOceanClient(adapter);

await client.v2.microvms.checkpoints
    .byCheckpoint_id("01a0ed98-0a74-75dd-a625-e4856adbc298").delete();

More Information

See /v2/microvms/checkpoints/{checkpoint_id} in the API reference for additional detail on responses, headers, parameters, and more.