dots.v2.insights.alertRules.get()

Generated on 13 Nov 2026 from DoTs version v1.24.0

Usage

client.v2.insights.alertRules.get(requestConfiguration?: RequestConfiguration<AlertRulesRequestBuilderGetQueryParameters>): Promise<undefined | AlertRulesGetResponse>

Description

To list alert rules for your account, send a GET request to /v2/insights/alert-rules. Results are paginated with page and per_page (default 20, maximum 200). Optionally filter by resource_urn.

Parameters

page integer optional

Example: 1

Which 'page' of paginated results to return.

Default: 1

Min: 1

perPage integer optional

Example: 2

Number of items returned per page

Default: 20

Min: 1

Max: 200

resourceUrn string optional

Example: do:droplet:12345

Optional filter. When set, only resources associated with this resource URN
are returned.

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.insights.alertRules.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.insights.alertRules.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.insights.alertRules.get({
        queryParameters: {
            page,
        },
    });
    pages = response?.links?.pages;
}

Response Example

Show Response Example
{
  "alert_rules": [
    {
      "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "spec": {
        "name": "High CPU",
        "query": {
          "metric": "do.droplets.cpu_utilization",
          "resource_urns": [
            "do:droplet:12345"
          ]
        },
        "condition": {
          "window": "EVALUATION_WINDOW_5M"
        },
        "thresholds": {
          "warning": 80,
          "critical": 95,
          "operator": "THRESHOLD_OPERATOR_GREATER_THAN"
        },
        "notification_channels": [
          {
            "notification_channel_id": "550e8400-e29b-41d4-a716-446655440000",
            "notify_on": [
              "SEVERITY_CRITICAL"
            ]
          }
        ],
        "re_alert_duration": "RE_ALERT_DURATION_4H"
      },
      "status": "ALERT_RULE_STATUS_PAUSED",
      "created_at": "2026-09-03T10:00:00Z",
      "updated_at": "2026-09-03T10:30:00Z"
    }
  ],
  "links": {
    "pages": {
      "first": "https://api.digitalocean.com/v2/insights/alert-rules?page=1",
      "last": "https://api.digitalocean.com/v2/insights/alert-rules?page=1"
    }
  },
  "meta": {
    "total": 1
  }
}

More Information

See /v2/insights/alert-rules 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.