dots.v2.microvms.byMicrovm_id().pause.post()

Generated on 5 Nov 2026 from DoTs version v1.23.0

Usage

client.v2.microvms.byMicrovm_id(microvm_id).pause.post(requestConfiguration?: RequestConfiguration<object>): Promise<undefined | PausePostResponse>

Description

To pause a MicroVM, send a POST request to /v2/microvms/{microvm_id}/pause.

Pausing suspends the MicroVM’s processes and preserves its memory, files, and processes. A paused MicroVM incurs storage charges only. The request returns when the change completes. Pausing a MicroVM that is already paused succeeds. The request returns HTTP 400 when the MicroVM is creating, terminated, or failed.

Parameters

microvm_id string required

Example: 01a0ef1a-d873-793d-ae6a-5dd6239be62a

The unique ID of the MicroVM.

Request Sample

Show 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);

const response = await client.v2.microvms
    .byMicrovm_id("01a0ef1a-d873-793d-ae6a-5dd6239be62a").pause.post();

Response Example

Show Response Example
{
  "microvm": {
    "id": "01a0ef1a-d873-793d-ae6a-5dd6239be62a",
    "name": "example-microvm",
    "region": "mkc1",
    "size": {
      "cpu": 1,
      "memory": 2048,
      "disk": 50
    },
    "source": {
      "oci_ref": "docker.io/library/nginx:latest"
    },
    "state": "running",
    "networking": "public",
    "auto_pause": {
      "enabled": true,
      "idle_timeout": "5m0s"
    },
    "auto_resume": true,
    "http_protocol": "http",
    "ports": [
      80
    ],
    "tags": [
      "example"
    ],
    "urls": [
      {
        "hostname": "01a0ef1a-d873-793d-ae6a-5dd6239be62a.mkc1.microvm.ondigitalocean.com",
        "port": 80,
        "default": true,
        "status": "ACTIVE"
      }
    ],
    "created_at": "2026-09-29T21:38:29Z"
  }
}

More Information

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

We can't find any results for your search.

Try using different keywords or simplifying your search terms.