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.monitoring.metrics.droplet.memory_free.get(requestConfiguration?: RequestConfiguration<Memory_freeRequestBuilderGetQueryParameters>): Promise<undefined | Metrics>

Description

To retrieve free memory metrics for a given droplet, send a GET request to /v2/monitoring/metrics/droplet/memory_free.

Parameters

hostId string required

Example: 17209102

The droplet ID.

start string required

Example: 1620683817

UNIX timestamp to start metric window.

end string required

Example: 1620705417

UNIX timestamp to end metric window.

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.monitoring.metrics.droplet.memory_free.get({
    queryParameters: {
        hostId: "17209102",
        start: "1620683817",
        end: "1620705417",
    },
});

Response Example

{
  "data": {
    "result": [],
    "resultType": "matrix"
  },
  "status": "success"
}

More Information

See /v2/monitoring/metrics/droplet/memory_free in the API reference for additional detail on responses, headers, parameters, and more.