dots.v2.microvms.byMicrovm_id().console.get()

Generated on 13 Nov 2026 from DoTs version v1.24.0

Usage

client.v2.microvms.byMicrovm_id(microvm_id).console.get(requestConfiguration?: RequestConfiguration<ConsoleRequestBuilderGetQueryParameters>): Promise<undefined | ArrayBuffer>

Description

To open an interactive /bin/sh console in a MicroVM’s workload container, open a WebSocket connection to wss://api.digitalocean.com/v2/microvms/{microvm_id}/console.

Send the API token in the Authorization header of the handshake. Browsers cannot set this header, so you cannot open the console from browser JavaScript. The image must include /bin/sh. A MicroVM can have four consoles open at a time. If the MicroVM is paused and auto-resume is on, opening a console resumes it.

Parameters

Path Parameters

microvm_id string required

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

The unique ID of the MicroVM.

Query Parameters

rows integer optional

Example: 24

The initial number of terminal rows.

Default: 24

Min: 1

Max: 65535

cols integer optional

Example: 80

The initial number of terminal columns.

Default: 80

Min: 1

Max: 65535

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

More Information

See /v2/microvms/{microvm_id}/console 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.