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
pageinteger optionalExample:
1Which 'page' of paginated results to return.
perPageinteger optionalExample:
25Number of items returned per page.
regionstring optionalExample:
mkc1Only return MicroVMs in this region.
namestring optionalExample:
example-microvmOnly return MicroVMs whose name contains this substring (case-insensitive).
tagNamestring optionalExample:
exampleOnly return MicroVMs with this tag. A tag that matches no MicroVMs returns an empty list.
Request Sample
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
More Information
See /v2/microvms in the API reference for additional detail on responses, headers, parameters, and more.