Sign in

v1

latestOpenAPI 3.0.02026-07-142351,1971.3 MB
Monitors

Get all monitors

Get all monitors from your organization.

get/api/v1/monitor

Query parameters

group_statesstring
Example:alert

When specified, shows additional information about the group states. Choose one or more from all, alert, warn, and no data.

namestring

A string to filter monitors by name.

tagsstring
Example:host:host0

A comma separated list indicating what tags, if any, should be used to filter the list of monitors by scope. For example, host:host0.

monitor_tagsstring
Example:service:my-app

A comma separated list indicating what service and/or custom tags, if any, should be used to filter the list of monitors. Tags created in the Datadog UI automatically have the service key prepended. For example, service:my-app.

with_downtimesboolean

If this argument is set to true, then the returned data includes all current active downtimes for each monitor.

id_offsetinteger

Use this parameter for paginating through large sets of monitors. Start with a value of zero, make a request, set the value to the last ID of result set, and then repeat until the response is empty.

pageinteger

The page to start paginating from. If this argument is not specified, the request returns all monitors without pagination.

page_sizeinteger
Example:20

The number of monitors to return per page. If the page argument is not specified, the default behavior returns all monitors without a page_size limit. However, if page is specified and page_size is not, the argument defaults to 100.

Response

OK

createdstring date-time

Timestamp of the monitor creation.

deletedstring date-time nullable

Whether or not the monitor is deleted. (Always null)

draft_status'draft' | 'published'

Indicates whether the monitor is in a draft or published state.

draft: The monitor appears as Draft and does not send notifications. published: The monitor is active and evaluates conditions and notify as configured.

This field is in preview. The draft value is only available to customers with the feature enabled.

idinteger

ID of this monitor.

messagestring

A message to include with notifications for this monitor.

modifiedstring date-time

Last timestamp when the monitor was edited.

multiboolean

Whether or not the monitor is broken down on different groups.

namestring

The monitor name.

overall_state'Alert' | 'Ignored' | 'No Data' | 'OK' | 'Skipped' | 'Unknown' | 'Warn'

The different states your monitor can be in.

priorityinteger nullable

Integer from 1 (high) to 5 (low) indicating alert severity.

querystring required

The monitor query.

restricted_rolesstring[] nullable

A list of unique role identifiers to define which roles are allowed to edit the monitor. The unique identifiers for all roles can be pulled from the Roles API and are located in the data.id field. Editing a monitor includes any updates to the monitor configuration, monitor deletion, and muting of the monitor for any amount of time. You can use the Restriction Policies API to manage write authorization for individual monitors by teams and users, in addition to roles.

tagsstring[]

Tags associated to your monitor.

type'composite' | 'event alert' | 'log alert' | 'metric alert' | 'process alert' | 'query alert' | 'rum alert' | 'service check' | 'synthetics alert' | 'trace-analytics alert' | 'slo alert' | 'event-v2 alert' | 'audit alert' | 'ci-pipelines alert' | 'ci-tests alert' | 'error-tracking alert' | 'database-monitoring alert' | 'network-performance alert' | 'cost alert' | 'data-quality alert' | 'network-path alert' | 'data-jobs alert' required

The type of the monitor. For more information about type, see the monitor options docs.