The DigitalOcean Insights API provides observability resources for monitoring your infrastructure, including alert rules that evaluate metrics, notification channels that deliver alert events, read-only alert instances that record when alert rules fire, PromQL, logs, spans, and traces query interfaces, and per-resource enablement of the metrics, logs, and traces signals.
Every API here is available over the APIs.io API and to AI agents over MCP.
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
find_apisBrowse and filter every API in the catalog.get_api_artifactsOne API's artifacts, grouped by type.get_openapiThe primary OpenAPI for this API.find_similar_apisAPIs that look like this one.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.curl "https://apis.io/api/v1/apis/digital-ocean:digital-ocean-insights-api"curl "https://apis.io/api/v1/apis?limit=25"Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.
Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.
openapi: 3.2.0
info:
title: DigitalOcean Insights API
version: '2.0'
description: 'The DigitalOcean Insights API provides observability resources for
monitoring your infrastructure, including alert rules that evaluate
metrics, notification channels that deliver alert events, read-only
alert instances that record when alert rules fire, PromQL, logs, spans,
and traces query interfaces, and per-resource enablement of the metrics,
logs, and traces signals.'
license:
name: Apache 2.0
url: https://www.apache.org/licenses/LICENSE-2.0.html
contact:
name: DigitalOcean API Team
email: api-engineering@digitalocean.com
termsOfService: https://www.digitalocean.com/legal/terms-of-service-agreement/
servers:
- url: https://api.digitalocean.com
description: production
security:
- bearer_auth: []
tags:
- name: Insights
description: 'The DigitalOcean Insights API provides observability resources for
monitoring your infrastructure, including alert rules that evaluate
metrics, notification channels that deliver alert events, read-only
alert instances that record when alert rules fire, PromQL, logs, spans,
and traces query interfaces, and per-resource enablement of the metrics,
logs, and traces signals.'
paths:
/v2/insights/alert-instances:
get:
$ref: resources/insights/insights_list_alertInstances.yml
tags:
- Insights
summary: Get insights alert instances
x-summary-source: derived
operationId: getV2InsightsAlertInstances
x-operation-id-source: derived
/v2/insights/alert-instances/{id}:
get:
$ref: resources/insights/insights_get_alertInstance.yml
tags:
- Insights
summary: Get insights alert instances by id
x-summary-source: derived
operationId: getV2InsightsAlertInstancesById
x-operation-id-source: derived
/v2/insights/alert-rules:
get:
$ref: resources/insights/insights_list_alertRules.yml
tags:
- Insights
summary: Get insights alert rules
x-summary-source: derived
operationId: getV2InsightsAlertRules
x-operation-id-source: derived
post:
$ref: resources/insights/insights_create_alertRule.yml
tags:
- Insights
summary: Create insights alert rules
x-summary-source: derived
operationId: postV2InsightsAlertRules
x-operation-id-source: derived
/v2/insights/alert-rules/{id}:
get:
$ref: resources/insights/insights_get_alertRule.yml
tags:
- Insights
summary: Get insights alert rules by id
x-summary-source: derived
operationId: getV2InsightsAlertRulesById
x-operation-id-source: derived
put:
$ref: resources/insights/insights_update_alertRule.yml
tags:
- Insights
summary: Replace insights alert rules by id
x-summary-source: derived
operationId: putV2InsightsAlertRulesById
x-operation-id-source: derived
delete:
$ref: resources/insights/insights_delete_alertRule.yml
tags:
- Insights
summary: Delete insights alert rules by id
x-summary-source: derived
operationId: deleteV2InsightsAlertRulesById
x-operation-id-source: derived
/v2/insights/notification-channels:
get:
$ref: resources/insights/insights_list_notificationChannels.yml
tags:
- Insights
summary: Get insights notification channels
x-summary-source: derived
operationId: getV2InsightsNotificationChannels
x-operation-id-source: derived
post:
$ref: resources/insights/insights_create_notificationChannel.yml
tags:
- Insights
summary: Create insights notification channels
x-summary-source: derived
operationId: postV2InsightsNotificationChannels
x-operation-id-source: derived
/v2/insights/notification-channels/{id}:
get:
$ref: resources/insights/insights_get_notificationChannel.yml
tags:
- Insights
summary: Get insights notification channels by id
x-summary-source: derived
operationId: getV2InsightsNotificationChannelsById
x-operation-id-source: derived
put:
$ref: resources/insights/insights_update_notificationChannel.yml
tags:
- Insights
summary: Replace insights notification channels by id
x-summary-source: derived
operationId: putV2InsightsNotificationChannelsById
x-operation-id-source: derived
delete:
$ref: resources/insights/insights_delete_notificationChannel.yml
tags:
- Insights
summary: Delete insights notification channels by id
x-summary-source: derived
operationId: deleteV2InsightsNotificationChannelsById
x-operation-id-source: derived
/v2/insights/query/{region}/prom/api/v1/query:
get:
$ref: resources/insights/insights_get_promQuery.yml
tags:
- Insights
summary: Get insights query by region prom api query
x-summary-source: derived
operationId: getV2InsightsQueryByRegionPromApiV1Query
x-operation-id-source: derived
post:
$ref: resources/insights/insights_post_promQuery.yml
tags:
- Insights
summary: Create insights query by region prom api query
x-summary-source: derived
operationId: postV2InsightsQueryByRegionPromApiV1Query
x-operation-id-source: derived
/v2/insights/query/{region}/prom/api/v1/query_range:
get:
$ref: resources/insights/insights_get_promQueryRange.yml
tags:
- Insights
summary: Get insights query by region prom api query range
x-summary-source: derived
operationId: getV2InsightsQueryByRegionPromApiV1QueryRange
x-operation-id-source: derived
post:
$ref: resources/insights/insights_post_promQueryRange.yml
tags:
- Insights
summary: Create insights query by region prom api query range
x-summary-source: derived
operationId: postV2InsightsQueryByRegionPromApiV1QueryRange
x-operation-id-source: derived
/v2/insights/query/{region}/prom/api/v1/labels:
get:
$ref: resources/insights/insights_get_promLabels.yml
tags:
- Insights
summary: Get insights query by region prom api labels
x-summary-source: derived
operationId: getV2InsightsQueryByRegionPromApiV1Labels
x-operation-id-source: derived
post:
$ref: resources/insights/insights_post_promLabels.yml
tags:
- Insights
summary: Create insights query by region prom api labels
x-summary-source: derived
operationId: postV2InsightsQueryByRegionPromApiV1Labels
x-operation-id-source: derived
/v2/insights/query/{region}/prom/api/v1/label/{name}/values:
get:
$ref: resources/insights/insights_get_promLabelValues.yml
tags:
- Insights
summary: Get insights query by region prom api label by name values
x-summary-source: derived
operationId: getV2InsightsQueryByRegionPromApiV1LabelByNameValues
x-operation-id-source: derived
/v2/insights/query/{region}/prom/api/v1/series:
get:
$ref: resources/insights/insights_get_promSeries.yml
tags:
- Insights
summary: Get insights query by region prom api series
x-summary-source: derived
operationId: getV2InsightsQueryByRegionPromApiV1Series
x-operation-id-source: derived
post:
$ref: resources/insights/insights_post_promSeries.yml
tags:
- Insights
summary: Create insights query by region prom api series
x-summary-source: derived
operationId: postV2InsightsQueryByRegionPromApiV1Series
x-operation-id-source: derived
/v2/insights/query/{region}/logs/search:
post:
$ref: resources/insights/insights_post_logsSearch.yml
tags:
- Insights
summary: Create insights query by region logs search
x-summary-source: derived
operationId: postV2InsightsQueryByRegionLogsSearch
x-operation-id-source: derived
/v2/insights/query/{region}/traces/search:
post:
$ref: resources/insights/insights_post_tracesSearch.yml
tags:
- Insights
summary: Create insights query by region traces search
x-summary-source: derived
operationId: postV2InsightsQueryByRegionTracesSearch
x-operation-id-source: derived
/v2/insights/query/{region}/traces/{trace_id}:
get:
$ref: resources/insights/insights_get_trace.yml
tags:
- Insights
summary: Get insights query by region traces by trace id
x-summary-source: derived
operationId: getV2InsightsQueryByRegionTracesByTraceId
x-operation-id-source: derived
/v2/insights/query/{region}/spans/search:
post:
$ref: resources/insights/insights_post_spansSearch.yml
tags:
- Insights
summary: Create insights query by region spans search
x-summary-source: derived
operationId: postV2InsightsQueryByRegionSpansSearch
x-operation-id-source: derived
/v2/insights/resources:
get:
$ref: resources/insights/insights_list_resources.yml
tags:
- Insights
summary: Get insights resources
x-summary-source: derived
operationId: getV2InsightsResources
x-operation-id-source: derived
/v2/insights/resources/{resource_urn}:
get:
$ref: resources/insights/insights_get_resource.yml
tags:
- Insights
summary: Get insights resources by resource urn
x-summary-source: derived
operationId: getV2InsightsResourcesByResourceUrn
x-operation-id-source: derived
/v2/insights/resources/{resource_urn}/signals:
put:
$ref: resources/insights/insights_update_resourceSignals.yml
tags:
- Insights
summary: Replace insights resources by resource urn signals
x-summary-source: derived
operationId: putV2InsightsResourcesByResourceUrnSignals
x-operation-id-source: derived
components:
securitySchemes:
bearer_auth:
type: http
scheme: bearer
description: '## OAuth Authentication
In order to interact with the DigitalOcean API, you or your application must
authenticate.
The DigitalOcean API handles this through OAuth, an open standard for
authorization. OAuth allows you to delegate access to your account.
Scopes can be used to grant full access, read-only access, or access to
a specific set of endpoints.
You can generate an OAuth token by visiting the [Apps & API](https://cloud.digitalocean.com/account/api/tokens)
section of the DigitalOcean control panel for your account.
An OAuth token functions as a complete authentication request. In effect, it
acts as a substitute for a username and password pair.
Because of this, it is absolutely **essential** that you keep your OAuth
tokens secure. In fact, upon generation, the web interface will only display
each token a single time in order to prevent the token from being compromised.
DigitalOcean access tokens begin with an identifiable prefix in order to
distinguish them from other similar tokens.
- `dop_v1_` for personal access tokens generated in the control panel
- `doo_v1_` for tokens generated by applications using [the OAuth flow](https://docs.digitalocean.com/reference/api/oauth-api/)
- `dor_v1_` for OAuth refresh tokens
### Scopes
Scopes act like permissions assigned to an API token. These permissions
determine what actions the token can perform. You can create API
tokens that grant read-only access, full access, or limited access to
specific endpoints by using custom scopes.
Generally, scopes are designed to match HTTP verbs and common CRUD
operations (Create, Read, Update, Delete).
| HTTP Verb | CRUD Operation | Scope |
|---|---|---|
| GET | Read | `<resource>:read` |
| POST | Create | `<resource>:create` |
| PUT/PATCH | Update | `<resource>:update` |
| DELETE | Delete | `<resource>:delete` |
For example, creating a new Droplet by making a `POST` request to the
`/v2/droplets` endpoint requires the `droplet:create` scope while
listing Droplets by making a `GET` request to the `/v2/droplets`
endpoint requires the `droplet:read` scope.
Each endpoint below specifies which scope is required to access it when
using custom scopes.
### How to Authenticate with OAuth
In order to make an authenticated request, include a bearer-type
`Authorization` header containing your OAuth token. All requests must be
made over HTTPS.
### Authenticate with a Bearer Authorization Header
```
curl -X $HTTP_METHOD -H "Authorization: Bearer $DIGITALOCEAN_TOKEN" "https://api.digitalocean.com/v2/$OBJECT"
```
'
inference_bearer_auth:
type: http
scheme: bearer
description: '## OAuth Authentication
In order to interact with the DigitalOcean API, you or your application must
authenticate.
The DigitalOcean API handles this through OAuth, an open standard for
authorization. OAuth allows you to delegate access to your account.
Scopes can be used to grant full access, read-only access, or access to
a specific set of endpoints.
You can generate an OAuth token by visiting the [Apps & API](https://cloud.digitalocean.com/account/api/tokens)
section of the DigitalOcean control panel for your account.
An OAuth token functions as a complete authentication request. In effect, it
acts as a substitute for a username and password pair.
Because of this, it is absolutely **essential** that you keep your OAuth
tokens secure. In fact, upon generation, the web interface will only display
each token a single time in order to prevent the token from being compromised.
DigitalOcean access tokens begin with an identifiable prefix in order to
distinguish them from other similar tokens.
- `dop_v1_` for personal access tokens generated in the control panel
- `doo_v1_` for tokens generated by applications using [the OAuth flow](https://docs.digitalocean.com/reference/api/oauth-api/)
- `dor_v1_` for OAuth refresh tokens
### Authenticate with a Bearer Authorization Header
**Serverless Inference:**
```
curl -X POST -H "Authorization: Bearer $DIGITALOCEAN_TOKEN" "https://inference.do-ai.run/v1/chat/completions"
```
**Agent Inference:**
```
curl -X POST -H "Authorization: Bearer $AGENT_ACCESS_KEY" "https://{your-agent-url}.agents.do-ai.run/v1/chat/completions?agent=true"
```
**Note:** Agent Inference APIs use an `agent_access_key` (endpoint access
key) instead of a DigitalOcean OAuth token. The `agent_access_key` is
provided when you provision an agent endpoint and is scoped to that
specific agent. It is not interchangeable with DigitalOcean OAuth tokens
(`dop_v1_*`, `doo_v1_*`, `dor_v1_*`), which are used with Serverless
Inference and the control-plane API at `https://api.digitalocean.com`.
'
x-tagGroups:
- name: Public APIs
tags:
- Public APIs Introduction
- 1-Click Applications
- Account
- Actions
- Add-Ons
- Action Gateway
- Action Gateway Data Plane
- Agent Platform API
- Apps
- Billing
- Block Storage
- Block Storage Actions
- BYOIP Prefixes
- CDN Endpoints
- Certificates
- Container Registry
- Container Registries
- Databases
- Dedicated Inference
- Domain Records
- Domains
- Droplet Actions
- Droplets
- Droplet Autoscale Pools
- Firewalls
- Floating IP Actions
- Floating IPs
- Functions
- Harness Runtime
- Image Actions
- Images
- Insights
- Kubernetes
- Load Balancers
- MicroVMs [Public Preview]
- Monitoring
- NFS
- NFS Actions
- Organizations
- Partner Network Connect
- Project Resources
- Projects
- Regions
- Reserved IP Actions
- Reserved IPs
- Reserved IPv6
- Reserved IPv6 Actions
- Security
- Signals
- Sizes
- Snapshots
- Spaces Keys
- SSH Keys
- Tags
- Uptime
- Vector Databases
- VPC NAT Gateways
- VPC Peerings
- VPC Routes [Public Preview]
- VPC Subnets [Public Preview]
- VPCs
- name: Inference APIs
tags:
- Inference Introduction
- Agent Inference
- Batch Inference
- Embeddings
- Serverless Inference