Interface MonitorsApiListMonitorsRequest

Hierarchy

  • MonitorsApiListMonitorsRequest

Properties

groupStates?: string

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

idOffset?: number

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.

monitorTags?: string

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.

name?: string

A string to filter monitors by name.

page?: number

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

pageSize?: number

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.

tags?: string

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

withDowntimes?: boolean

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

Generated using TypeDoc