dots.v2.microvms.get()

Generated on 13 Nov 2026 from DoTs version v1.24.0

Usage

client.v2.microvms.get(requestConfiguration?: RequestConfiguration<MicrovmsRequestBuilderGetQueryParameters>): Promise<undefined | MicrovmsGetResponse>

Description

To list all of the MicroVMs on your team, send a GET request to /v2/microvms.

The region, name, and tag_name filters combine with AND.

Parameters

page integer optional

Example: 1

Which 'page' of paginated results to return.

Default: 1

Min: 1

perPage integer optional

Example: 25

Number of items returned per page.

Default: 25

Min: 1

Max: 200

region string optional

Example: mkc1

Only return MicroVMs in this region.

name string optional

Example: example-microvm

Only return MicroVMs whose name contains this substring (case-insensitive).

tagName string optional

Example: example

Only return MicroVMs with this tag. A tag that matches no MicroVMs returns an empty list.

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.get();

Pagination

This method returns paginated results. The response includes a links.pages object with URLs for navigating between pages. To retrieve the next page, parse the next URL and pass the page query parameter:

let response = await client.v2.microvms.get();
let pages = response?.links?.pages;

while (pages && "next" in pages && typeof pages.next === "string") {
    const page = Number(new URL(pages.next).searchParams.get("page"));
    response = await client.v2.microvms.get({
        queryParameters: {
            page,
        },
    });
    pages = response?.links?.pages;
}

Response Example

Show Response Example
{
  "microvms": [
    {
      "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": "paused",
      "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"
    }
  ],
  "links": {
    "pages": {
      "last": "/v2/microvms?page=4&per_page=1",
      "next": "/v2/microvms?page=2&per_page=1"
    }
  },
  "meta": {
    "page": 1,
    "per_page": 1,
    "total": 4
  }
}

More Information

See /v2/microvms 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.