> ## Documentation Index
> Fetch the complete documentation index at: https://docs.pinkfish.ai/llms.txt
> Use this file to discover all available pages before exploring further.
# datadog-monitoring
> Datadog Monitoring - monitors, SLOs, downtimes, events, incidents, and on-call schedules
**Server path:** `/datadog-monitoring` | **Type:** Application | **PCID required:** Yes
## Tools
| Tool | Description |
| ------------------------------------------------------------------------------------------------------- | --------------------------------- |
| [`datadog_monitoring_check_can_delete_monitor`](#datadog_monitoring_check_can_delete_monitor) | Check if a monitor can be deleted |
| [`datadog_monitoring_create_incident`](#datadog_monitoring_create_incident) | Create an incident |
| [`datadog_monitoring_create_monitor`](#datadog_monitoring_create_monitor) | Create a monitor |
| [`datadog_monitoring_create_slo`](#datadog_monitoring_create_slo) | Create an SLO object |
| [`datadog_monitoring_delete_incident`](#datadog_monitoring_delete_incident) | Delete an existing incident |
| [`datadog_monitoring_delete_monitor`](#datadog_monitoring_delete_monitor) | Delete a monitor |
| [`datadog_monitoring_delete_slo`](#datadog_monitoring_delete_slo) | Delete an SLO |
| [`datadog_monitoring_get_event`](#datadog_monitoring_get_event) | Get an event |
| [`datadog_monitoring_get_incident`](#datadog_monitoring_get_incident) | Get the details of an incident |
| [`datadog_monitoring_get_monitor`](#datadog_monitoring_get_monitor) | Get a monitor's details |
| [`datadog_monitoring_get_on_call_escalation_policy`](#datadog_monitoring_get_on_call_escalation_policy) | Get On-Call escalation policy |
| [`datadog_monitoring_get_on_call_schedule`](#datadog_monitoring_get_on_call_schedule) | Get On-Call schedule |
| [`datadog_monitoring_get_slo`](#datadog_monitoring_get_slo) | Get an SLO's details |
| [`datadog_monitoring_get_slohistory`](#datadog_monitoring_get_slohistory) | Get an SLO's history |
| [`datadog_monitoring_list_events`](#datadog_monitoring_list_events) | Get a list of events |
| [`datadog_monitoring_list_incident_attachments`](#datadog_monitoring_list_incident_attachments) | List incident attachments |
| [`datadog_monitoring_list_incidents`](#datadog_monitoring_list_incidents) | Get a list of incidents |
| [`datadog_monitoring_list_monitors`](#datadog_monitoring_list_monitors) | Get all monitors |
| [`datadog_monitoring_list_slos`](#datadog_monitoring_list_slos) | Get all SLOs |
| [`datadog_monitoring_search_incidents`](#datadog_monitoring_search_incidents) | Search for incidents |
| [`datadog_monitoring_search_monitor_groups`](#datadog_monitoring_search_monitor_groups) | Monitors group search |
| [`datadog_monitoring_search_monitors`](#datadog_monitoring_search_monitors) | Monitors search |
| [`datadog_monitoring_update_incident`](#datadog_monitoring_update_incident) | Update an existing incident |
| [`datadog_monitoring_update_monitor`](#datadog_monitoring_update_monitor) | Edit a monitor |
| [`datadog_monitoring_update_slo`](#datadog_monitoring_update_slo) | Update an SLO |
| [`datadog_monitoring_validate_existing_monitor`](#datadog_monitoring_validate_existing_monitor) | Validate an existing monitor |
| [`datadog_monitoring_validate_monitor`](#datadog_monitoring_validate_monitor) | Validate a monitor |
***
## datadog\_monitoring\_check\_can\_delete\_monitor
Check if a monitor can be deleted
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ------------- | ---------- | -------- | ------- | -------------------------------- |
| `monitor_ids` | integer\[] | Yes | — | The IDs of the monitor to check. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"monitor_ids": {
"type": "array",
"items": {
"type": "integer",
"format": "int64"
},
"description": "The IDs of the monitor to check."
}
},
"required": [
"PCID",
"monitor_ids"
]
}
```
***
## datadog\_monitoring\_create\_incident
Create an incident
**Parameters:**
| Parameter | Type | Required | Default | Description |
| --------- | ------ | -------- | ------- | ----------------------------------- |
| `data` | object | Yes | — | Incident data for a create request. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"data": {
"type": "object",
"description": "Incident data for a create request.",
"properties": {
"attributes": {
"type": "object",
"description": "The incident's attributes for a create request."
},
"relationships": {
"type": "object",
"description": "The relationships the incident will have with other resources once created."
},
"type": {
"type": "string",
"description": "Incident resource type.",
"enum": [
"incidents"
]
}
},
"required": [
"type",
"attributes"
]
}
},
"required": [
"PCID",
"data"
]
}
```
***
## datadog\_monitoring\_create\_monitor
Create a monitor
**Parameters:**
| Parameter | Type | Required | Default | Description | |
| -------------------- | --------- | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ----------------------------------------------------------- |
| `assets` | object\[] | No | — | The list of monitor assets tied to a monitor, which represents key links for users to take action on monitor alerts (for example, runbooks). | |
| `created` | string | No | — | Timestamp of the monitor creation. | |
| `creator` | object | No | — | Object describing the creator of the shared element. | |
| `deleted` | string | null | No | — | Whether or not the monitor is deleted. (Always `null`) |
| `draft_status` | string | No | — | 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. | |
| `id` | integer | No | — | ID of this monitor. | |
| `matching_downtimes` | object\[] | No | — | A list of active v1 downtimes that match this monitor. | |
| `message` | string | No | — | A message to include with notifications for this monitor. | |
| `modified` | string | No | — | Last timestamp when the monitor was edited. | |
| `multi` | boolean | No | — | Whether or not the monitor is broken down on different groups. | |
| `name` | string | No | — | The monitor name. | |
| `options` | object | No | — | List of options associated with your monitor. | |
| `overall_state` | string | No | — | The different states your monitor can be in. | |
| `priority` | integer | null | No | — | Integer from 1 (high) to 5 (low) indicating alert severity. |
| `query` | string | Yes | — | The monitor query. | |
| `restricted_roles` | string\[] | No | — | 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](https://docs.datadoghq.com/api/latest/roles/#list-roles) 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](https://docs.datadoghq.com/api/latest/restriction-policies/) to manage write authorization for individual monitors by teams and users, in addition to roles. | |
| `state` | object | No | — | Wrapper object with the different monitor states. | |
| `tags` | string\[] | No | — | Tags associated to your monitor. | |
| `type` | string | Yes | — | The type of the monitor. For more information about `type`, see the [monitor options](https://docs.datadoghq.com/monitors/guide/monitor_api_options/) docs. | |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"assets": {
"type": "array",
"items": {
"type": "object",
"properties": {
"category": {
"type": "string",
"enum": [
"runbook"
],
"description": "Indicates the type of asset this entity represents on a monitor."
},
"name": {
"type": "string",
"description": "Name for the monitor asset"
},
"resource_key": {
"type": "string",
"description": "Represents the identifier of the internal Datadog resource that this asset represents. IDs in this field should be passed in as strings."
},
"resource_type": {
"type": "string",
"enum": [
"notebook"
],
"description": "Type of internal Datadog resource associated with a monitor asset."
},
"url": {
"type": "string",
"description": "URL link for the asset. For links with an internal resource type set, this should be the relative path to where the Datadog domain is appended internally. For external links, this should be the full URL path."
}
},
"required": [
"name",
"url",
"category"
]
},
"description": "The list of monitor assets tied to a monitor, which represents key links for users to take action on monitor alerts (for example, runbooks)."
},
"created": {
"type": "string",
"description": "Timestamp of the monitor creation."
},
"creator": {
"type": "object",
"description": "Object describing the creator of the shared element.",
"properties": {
"email": {
"type": "string",
"description": "Email of the creator."
},
"handle": {
"type": "string",
"description": "Handle of the creator."
},
"name": {
"type": "string",
"description": "Name of the creator."
}
}
},
"deleted": {
"type": [
"string",
"null"
],
"description": "Whether or not the monitor is deleted. (Always `null`)"
},
"draft_status": {
"type": "string",
"description": "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.",
"enum": [
"draft",
"published"
]
},
"id": {
"type": "integer",
"description": "ID of this monitor."
},
"matching_downtimes": {
"type": "array",
"items": {
"type": "object",
"properties": {
"end": {
"type": "integer",
"format": "int64",
"description": "POSIX timestamp to end the downtime."
},
"id": {
"type": "integer",
"format": "int64",
"description": "The downtime ID."
},
"scope": {
"type": "array",
"items": {
"type": "string"
},
"description": "The scope(s) to which the downtime applies. Must be in `key:value` format. For example, `host:app2`. Provide multiple scopes as a comma-separated list like `env:dev,env:prod`. The resulting downtime applies to sources that matches ALL provided scopes (`env:dev` **AND** `env:prod`)."
},
"start": {
"type": "integer",
"format": "int64",
"description": "POSIX timestamp to start the downtime."
}
},
"required": [
"id"
]
},
"description": "A list of active v1 downtimes that match this monitor."
},
"message": {
"type": "string",
"description": "A message to include with notifications for this monitor."
},
"modified": {
"type": "string",
"description": "Last timestamp when the monitor was edited."
},
"multi": {
"type": "boolean",
"description": "Whether or not the monitor is broken down on different groups."
},
"name": {
"type": "string",
"description": "The monitor name."
},
"options": {
"type": "object",
"description": "List of options associated with your monitor.",
"properties": {
"aggregation": {
"type": "object",
"description": "Type of aggregation performed in the monitor query."
},
"device_ids": {
"type": "array",
"items": {
"type": "string",
"enum": [
"laptop_large",
"tablet",
"mobile_small",
"chrome.laptop_large",
"chrome.tablet",
"chrome.mobile_small",
"firefox.laptop_large",
"firefox.tablet",
"firefox.mobile_small"
]
},
"description": "IDs of the device the Synthetics monitor is running on."
},
"enable_logs_sample": {
"type": "boolean",
"description": "Whether or not to send a log sample when the log monitor triggers."
},
"enable_samples": {
"type": "boolean",
"description": "Whether or not to send a list of samples when the monitor triggers. This is only used by CI Test and Pipeline monitors."
},
"escalation_message": {
"type": "string",
"description": "We recommend using the [is_renotify](https://docs.datadoghq.com/monitors/notify/?tab=is_alert#renotify), block in the original message instead. A message to include with a re-notification. Supports the `@username` notification we allow elsewhere. Not applicable if `renotify_interval` is `None`."
},
"evaluation_delay": {
"type": "integer",
"description": "Time (in seconds) to delay evaluation, as a non-negative integer. For example, if the value is set to `300` (5min), the timeframe is set to `last_5m` and the time is 7:00, the monitor evaluates data from 6:50 to 6:55. This is useful for AWS CloudWatch and other backfilled metrics to ensure the monitor always has data during evaluation."
},
"group_retention_duration": {
"type": "string",
"description": "The time span after which groups with missing data are dropped from the monitor state. The minimum value is one hour, and the maximum value is 72 hours. Example values are: \"60m\", \"1h\", and \"2d\". This option is only available for APM Trace Analytics, Audit Trail, CI, Error Tracking, Event, Logs, and RUM monitors."
},
"groupby_simple_monitor": {
"type": "boolean",
"description": "Whether the log alert monitor triggers a single alert or multiple alerts when any group breaches a threshold. Use `notify_by` instead."
},
"include_tags": {
"type": "boolean",
"description": "A Boolean indicating whether notifications from this monitor automatically inserts its triggering tags into the title. **Examples** - If `True`, `[Triggered on {host:h1}] Monitor Title` - If `False`, `[Triggered] Monitor Title`"
},
"locked": {
"type": "boolean",
"description": "Whether or not the monitor is locked (only editable by creator and admins). Use `restricted_roles` instead."
},
"min_failure_duration": {
"type": "integer",
"description": "How long the test should be in failure before alerting (integer, number of seconds, max 7200)."
},
"min_location_failed": {
"type": "integer",
"description": "The minimum number of locations in failure at the same time during at least one moment in the `min_failure_duration` period (`min_location_failed` and `min_failure_duration` are part of the advanced alerting rules - integer, >= 1)."
},
"new_group_delay": {
"type": "integer",
"description": "Time (in seconds) to skip evaluations for new groups. For example, this option can be used to skip evaluations for new hosts while they initialize. Must be a non negative integer."
},
"new_host_delay": {
"type": "integer",
"description": "Time (in seconds) to allow a host to boot and applications to fully start before starting the evaluation of monitor results. Should be a non negative integer. Use new_group_delay instead."
},
"no_data_timeframe": {
"type": "integer",
"description": "The number of minutes before a monitor notifies after data stops reporting. Datadog recommends at least 2x the monitor timeframe for query alerts or 2 minutes for service checks. If omitted, 2x the evaluation timeframe is used for query alerts, and 24 hours is used for service checks."
},
"notification_preset_name": {
"type": "string",
"description": "Toggles the display of additional content sent in the monitor notification.",
"enum": [
"show_all",
"hide_query",
"hide_handles",
"hide_all",
"hide_query_and_handles",
"show_only_snapshot",
"hide_handles_and_footer"
]
},
"notify_audit": {
"type": "boolean",
"description": "A Boolean indicating whether tagged users is notified on changes to this monitor."
},
"notify_by": {
"type": "array",
"items": {
"type": "string"
},
"description": "Controls what granularity a monitor alerts on. Only available for monitors with groupings. For instance, a monitor grouped by `cluster`, `namespace`, and `pod` can be configured to only notify on each new `cluster` violating the alert conditions by setting `notify_by` to `[\"cluster\"]`. Tags mentioned in `notify_by` must be a subset of the grouping tags in the query. For example, a query grouped by `cluster` and `namespace` cannot notify on `region`. Setting `notify_by` to `[\"*\"]` configures the monitor to notify as a simple-alert."
},
"notify_no_data": {
"type": "boolean",
"description": "A Boolean indicating whether this monitor notifies when data stops reporting. Defaults to `false`."
},
"on_missing_data": {
"type": "string",
"description": "Controls how groups or monitors are treated if an evaluation does not return any data points. The default option results in different behavior depending on the monitor query type. For monitors using Count queries, an empty monitor evaluation is treated as 0 and is compared to the threshold conditions. For monitors using any query type other than Count, for example Gauge, Measure, or Rate, the monitor shows the last known status. This option is only available for APM Trace Analytics, Audit Trail, CI, Error Tracking, Event, Logs, and RUM monitors.",
"enum": [
"default",
"show_no_data",
"show_and_notify_no_data",
"resolve"
]
},
"renotify_interval": {
"type": "integer",
"description": "The number of minutes after the last notification before a monitor re-notifies on the current status. It only re-notifies if it’s not resolved."
},
"renotify_occurrences": {
"type": "integer",
"description": "The number of times re-notification messages should be sent on the current status at the provided re-notification interval."
},
"renotify_statuses": {
"type": "array",
"items": {
"type": "string",
"enum": [
"alert",
"warn",
"no data"
]
},
"description": "The types of monitor statuses for which re-notification messages are sent. Default: **null** if `renotify_interval` is **null**. If `renotify_interval` is set, defaults to renotify on `Alert` and `No Data`."
},
"require_full_window": {
"type": "boolean",
"description": "A Boolean indicating whether this monitor needs a full window of data before it’s evaluated. We highly recommend you set this to `false` for sparse metrics, otherwise some evaluations are skipped. Default is false. This setting only applies to metric monitors."
},
"scheduling_options": {
"type": "object",
"description": "Configuration options for scheduling."
},
"silenced": {
"type": "object",
"description": "Information about the downtime applied to the monitor. Only shows v1 downtimes."
},
"synthetics_check_id": {
"type": "string",
"description": "ID of the corresponding Synthetic check."
},
"threshold_windows": {
"type": "object",
"description": "Alerting time window options."
},
"thresholds": {
"type": "object",
"description": "List of the different monitor threshold available."
},
"timeout_h": {
"type": "integer",
"description": "The number of hours of the monitor not reporting data before it automatically resolves from a triggered state. The minimum allowed value is 0 hours. The maximum allowed value is 24 hours."
},
"variables": {
"type": "array",
"description": "List of requests that can be used in the monitor query. **This feature is currently in beta.**"
}
}
},
"overall_state": {
"type": "string",
"description": "The different states your monitor can be in.",
"enum": [
"Alert",
"Ignored",
"No Data",
"OK",
"Skipped",
"Unknown",
"Warn"
]
},
"priority": {
"type": [
"integer",
"null"
],
"description": "Integer from 1 (high) to 5 (low) indicating alert severity."
},
"query": {
"type": "string",
"description": "The monitor query."
},
"restricted_roles": {
"type": "array",
"items": {
"type": "string"
},
"description": "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](https://docs.datadoghq.com/api/latest/roles/#list-roles) 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](https://docs.datadoghq.com/api/latest/restriction-policies/) to manage write authorization for individual monitors by teams and users, in addition to roles."
},
"state": {
"type": "object",
"description": "Wrapper object with the different monitor states.",
"properties": {
"groups": {
"type": "object",
"description": "Dictionary where the keys are groups (comma separated lists of tags) and the values are the list of groups your monitor is broken down on."
}
}
},
"tags": {
"type": "array",
"items": {
"type": "string"
},
"description": "Tags associated to your monitor."
},
"type": {
"type": "string",
"description": "The type of the monitor. For more information about `type`, see the [monitor options](https://docs.datadoghq.com/monitors/guide/monitor_api_options/) docs.",
"enum": [
"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"
]
}
},
"required": [
"PCID",
"query",
"type"
]
}
```
***
## datadog\_monitoring\_create\_slo
Create an SLO object
**Parameters:**
| Parameter | Type | Required | Default | Description | |
| ------------------- | ---------- | -------- | ------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `description` | string | null | No | — | A user-defined description of the service level objective. Always included in service level objective responses (but may be `null`). Optional in create/update requests. |
| `groups` | string\[] | No | — | A list of (up to 100) monitor groups that narrow the scope of a monitor service level objective. Included in service level objective responses if it is not empty. Optional in create/update requests for monitor service level objectives, but may only be used when then length of the `monitor_ids` field is one. | |
| `monitor_ids` | integer\[] | No | — | A list of monitor IDs that defines the scope of a monitor service level objective. **Required if type is `monitor`**. | |
| `name` | string | Yes | — | The name of the service level objective object. | |
| `query` | object | No | — | A count-based (metric) SLO query. This field is superseded by `sli_specification` but is retained for backwards compatibility. Note that Datadog only allows the sum by aggregator to be used because this will sum up all request counts instead of averaging them, or taking the max or min of all of those requests. | |
| `sli_specification` | object | No | — | A generic SLI specification. This is used for time-slice and count-based (metric) SLOs only. | |
| `tags` | string\[] | No | — | A list of tags associated with this service level objective. Always included in service level objective responses (but may be empty). Optional in create/update requests. | |
| `target_threshold` | number | No | — | The target threshold such that when the service level indicator is above this threshold over the given timeframe, the objective is being met. | |
| `thresholds` | object\[] | Yes | — | The thresholds (timeframes and associated targets) for this service level objective object. | |
| `timeframe` | string | No | — | The SLO time window options. Note that "custom" is not a valid option for creating or updating SLOs. It is only used when querying SLO history over custom timeframes. | |
| `type` | string | Yes | — | The type of the service level objective. | |
| `warning_threshold` | number | No | — | The optional warning threshold such that when the service level indicator is below this value for the given threshold, but above the target threshold, the objective appears in a "warning" state. This value must be greater than the target threshold. | |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"description": {
"type": [
"string",
"null"
],
"description": "A user-defined description of the service level objective. Always included in service level objective responses (but may be `null`). Optional in create/update requests."
},
"groups": {
"type": "array",
"items": {
"type": "string"
},
"description": "A list of (up to 100) monitor groups that narrow the scope of a monitor service level objective. Included in service level objective responses if it is not empty. Optional in create/update requests for monitor service level objectives, but may only be used when then length of the `monitor_ids` field is one."
},
"monitor_ids": {
"type": "array",
"items": {
"type": "integer",
"format": "int64"
},
"description": "A list of monitor IDs that defines the scope of a monitor service level objective. **Required if type is `monitor`**."
},
"name": {
"type": "string",
"description": "The name of the service level objective object."
},
"query": {
"type": "object",
"description": "A count-based (metric) SLO query. This field is superseded by `sli_specification` but is retained for backwards compatibility. Note that Datadog only allows the sum by aggregator to be used because this will sum up all request counts instead of averaging them, or taking the max or min of all of those requests.",
"properties": {
"denominator": {
"type": "string",
"description": "A Datadog metric query for total (valid) events."
},
"numerator": {
"type": "string",
"description": "A Datadog metric query for good events."
}
},
"required": [
"numerator",
"denominator"
]
},
"sli_specification": {
"description": "A generic SLI specification. This is used for time-slice and count-based (metric) SLOs only."
},
"tags": {
"type": "array",
"items": {
"type": "string"
},
"description": "A list of tags associated with this service level objective. Always included in service level objective responses (but may be empty). Optional in create/update requests."
},
"target_threshold": {
"type": "number",
"description": "The target threshold such that when the service level indicator is above this threshold over the given timeframe, the objective is being met."
},
"thresholds": {
"type": "array",
"items": {
"type": "object",
"properties": {
"target": {
"type": "number",
"format": "double",
"description": "The target value for the service level indicator within the corresponding timeframe."
},
"target_display": {
"type": "string",
"description": "A string representation of the target that indicates its precision. It uses trailing zeros to show significant decimal places (for example `98.00`). Always included in service level objective responses. Ignored in create/update requests."
},
"timeframe": {
"type": "string",
"enum": [
"7d",
"30d",
"90d",
"custom"
],
"description": "The SLO time window options. Note that \"custom\" is not a valid option for creating or updating SLOs. It is only used when querying SLO history over custom timeframes."
},
"warning": {
"type": "number",
"format": "double",
"description": "The warning value for the service level objective."
},
"warning_display": {
"type": "string",
"description": "A string representation of the warning target (see the description of the `target_display` field for details). Included in service level objective responses if a warning target exists. Ignored in create/update requests."
}
},
"required": [
"timeframe",
"target"
]
},
"description": "The thresholds (timeframes and associated targets) for this service level objective object."
},
"timeframe": {
"type": "string",
"description": "The SLO time window options. Note that \"custom\" is not a valid option for creating or updating SLOs. It is only used when querying SLO history over custom timeframes.",
"enum": [
"7d",
"30d",
"90d",
"custom"
]
},
"type": {
"type": "string",
"description": "The type of the service level objective.",
"enum": [
"metric",
"monitor",
"time_slice"
]
},
"warning_threshold": {
"type": "number",
"description": "The optional warning threshold such that when the service level indicator is below this value for the given threshold, but above the target threshold, the objective appears in a \"warning\" state. This value must be greater than the target threshold."
}
},
"required": [
"PCID",
"name",
"thresholds",
"type"
]
}
```
***
## datadog\_monitoring\_delete\_incident
Delete an existing incident
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ------------- | ------ | -------- | ------- | ------------------------- |
| `incident_id` | string | Yes | — | The UUID of the incident. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"incident_id": {
"type": "string",
"description": "The UUID of the incident."
}
},
"required": [
"PCID",
"incident_id"
]
}
```
***
## datadog\_monitoring\_delete\_monitor
Delete a monitor
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ------------ | ------- | -------- | ------- | --------------------------------------------------------------------------------------------------- |
| `monitor_id` | integer | Yes | — | The ID of the monitor. |
| `force` | string | No | — | Delete the monitor even if it's referenced by other resources (for example SLO, composite monitor). |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"monitor_id": {
"type": "integer",
"description": "The ID of the monitor."
},
"force": {
"type": "string",
"description": "Delete the monitor even if it's referenced by other resources (for example SLO, composite monitor)."
}
},
"required": [
"PCID",
"monitor_id"
]
}
```
***
## datadog\_monitoring\_delete\_slo
Delete an SLO
**Parameters:**
| Parameter | Type | Required | Default | Description |
| --------- | ------ | -------- | ------- | --------------------------------------------------------------------------------------------------- |
| `slo_id` | string | Yes | — | The ID of the service level objective. |
| `force` | string | No | — | Delete the monitor even if it's referenced by other resources (for example SLO, composite monitor). |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"slo_id": {
"type": "string",
"description": "The ID of the service level objective."
},
"force": {
"type": "string",
"description": "Delete the monitor even if it's referenced by other resources (for example SLO, composite monitor)."
}
},
"required": [
"PCID",
"slo_id"
]
}
```
***
## datadog\_monitoring\_get\_event
Get an event
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ---------- | ------- | -------- | ------- | -------------------- |
| `event_id` | integer | Yes | — | The ID of the event. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"event_id": {
"type": "integer",
"description": "The ID of the event."
}
},
"required": [
"PCID",
"event_id"
]
}
```
***
## datadog\_monitoring\_get\_incident
Get the details of an incident
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ------------- | --------- | -------- | ------- | ---------------------------------------------------------------------------- |
| `incident_id` | string | Yes | — | The UUID of the incident. |
| `include` | string\[] | No | — | Specifies which types of related objects should be included in the response. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"incident_id": {
"type": "string",
"description": "The UUID of the incident."
},
"include": {
"type": "array",
"items": {
"type": "string",
"enum": [
"users",
"attachments"
]
},
"description": "Specifies which types of related objects should be included in the response."
}
},
"required": [
"PCID",
"incident_id"
]
}
```
***
## datadog\_monitoring\_get\_monitor
Get a monitor's details
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ---------------- | ------- | -------- | ------- | ----------------------------------------------------------------------------------------------------------------------------------- |
| `monitor_id` | integer | Yes | — | The ID of the monitor |
| `group_states` | string | No | — | When specified, shows additional information about the group states. Choose one or more from `all`, `alert`, `warn`, and `no data`. |
| `with_downtimes` | boolean | No | — | If this argument is set to true, then the returned data includes all current active downtimes for the monitor. |
| `with_assets` | boolean | No | — | If this argument is set to `true`, the returned data includes all assets tied to this monitor. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"monitor_id": {
"type": "integer",
"description": "The ID of the monitor"
},
"group_states": {
"type": "string",
"description": "When specified, shows additional information about the group states. Choose one or more from `all`, `alert`, `warn`, and `no data`."
},
"with_downtimes": {
"type": "boolean",
"description": "If this argument is set to true, then the returned data includes all current active downtimes for the monitor."
},
"with_assets": {
"type": "boolean",
"description": "If this argument is set to `true`, the returned data includes all assets tied to this monitor."
}
},
"required": [
"PCID",
"monitor_id"
]
}
```
***
## datadog\_monitoring\_get\_on\_call\_escalation\_policy
Get On-Call escalation policy
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ----------- | ------ | -------- | ------- | ----------------------------------------------------------------------------------------------------------------- |
| `policy_id` | string | Yes | — | The ID of the escalation policy |
| `include` | string | No | — | Comma-separated list of included relationships to be returned. Allowed values: `teams`, `steps`, `steps.targets`. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"policy_id": {
"type": "string",
"description": "The ID of the escalation policy"
},
"include": {
"type": "string",
"description": "Comma-separated list of included relationships to be returned. Allowed values: `teams`, `steps`, `steps.targets`."
}
},
"required": [
"PCID",
"policy_id"
]
}
```
***
## datadog\_monitoring\_get\_on\_call\_schedule
Get On-Call schedule
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ------------- | ------ | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------ |
| `include` | string | No | — | Comma-separated list of included relationships to be returned. Allowed values: `teams`, `layers`, `layers.members`, `layers.members.user`. |
| `schedule_id` | string | Yes | — | The ID of the schedule |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"include": {
"type": "string",
"description": "Comma-separated list of included relationships to be returned. Allowed values: `teams`, `layers`, `layers.members`, `layers.members.user`."
},
"schedule_id": {
"type": "string",
"description": "The ID of the schedule"
}
},
"required": [
"PCID",
"schedule_id"
]
}
```
***
## datadog\_monitoring\_get\_slo
Get an SLO's details
**Parameters:**
| Parameter | Type | Required | Default | Description |
| --------------------------- | ------- | -------- | ------- | ---------------------------------------------------- |
| `slo_id` | string | Yes | — | The ID of the service level objective object. |
| `with_configured_alert_ids` | boolean | No | — | Get the IDs of SLO monitors that reference this SLO. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"slo_id": {
"type": "string",
"description": "The ID of the service level objective object."
},
"with_configured_alert_ids": {
"type": "boolean",
"description": "Get the IDs of SLO monitors that reference this SLO."
}
},
"required": [
"PCID",
"slo_id"
]
}
```
***
## datadog\_monitoring\_get\_slohistory
Get an SLO's history
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ------------------ | ------- | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `slo_id` | string | Yes | — | The ID of the service level objective object. |
| `from_ts` | integer | Yes | — | The `from` timestamp for the query window in epoch seconds. |
| `to_ts` | integer | Yes | — | The `to` timestamp for the query window in epoch seconds. |
| `target` | number | No | — | The SLO target. If `target` is passed in, the response will include the remaining error budget and a timeframe value of `custom`. |
| `apply_correction` | boolean | No | — | Defaults to `true`. If any SLO corrections are applied and this parameter is set to `false`, then the corrections will not be applied and the SLI values will not be affected. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"slo_id": {
"type": "string",
"description": "The ID of the service level objective object."
},
"from_ts": {
"type": "integer",
"description": "The `from` timestamp for the query window in epoch seconds."
},
"to_ts": {
"type": "integer",
"description": "The `to` timestamp for the query window in epoch seconds."
},
"target": {
"type": "number",
"description": "The SLO target. If `target` is passed in, the response will include the remaining error budget and a timeframe value of `custom`."
},
"apply_correction": {
"type": "boolean",
"description": "Defaults to `true`. If any SLO corrections are applied and this parameter is set to `false`, then the corrections will not be applied and the SLI values will not be affected."
}
},
"required": [
"PCID",
"slo_id",
"from_ts",
"to_ts"
]
}
```
***
## datadog\_monitoring\_list\_events
Get a list of events
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ------------------- | ------- | -------- | ------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `start` | integer | Yes | — | POSIX timestamp. |
| `end` | integer | Yes | — | POSIX timestamp. |
| `priority` | string | No | — | Priority of your events, either `low` or `normal`. |
| `sources` | string | No | — | A comma separated string of sources. |
| `tags` | string | No | — | A comma separated list indicating what tags, if any, should be used to filter the list of events. |
| `unaggregated` | boolean | No | — | Set unaggregated to `true` to return all events within the specified \[`start`,`end`] timeframe. Otherwise if an event is aggregated to a parent event with a timestamp outside of the timeframe, it won't be available in the output. Aggregated events with `is_aggregate=true` in the response will still be returned unless exclude\_aggregate is set to `true.` |
| `exclude_aggregate` | boolean | No | — | Set `exclude_aggregate` to `true` to only return unaggregated events where `is_aggregate=false` in the response. If the `exclude_aggregate` parameter is set to `true`, then the unaggregated parameter is ignored and will be `true` by default. |
| `page` | integer | No | — | By default 1000 results are returned per request. Set page to the number of the page to return with `0` being the first page. The page parameter can only be used when either unaggregated or exclude\_aggregate is set to `true.` |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"start": {
"type": "integer",
"description": "POSIX timestamp."
},
"end": {
"type": "integer",
"description": "POSIX timestamp."
},
"priority": {
"type": "string",
"description": "Priority of your events, either `low` or `normal`.",
"enum": [
"normal",
"low"
]
},
"sources": {
"type": "string",
"description": "A comma separated string of sources."
},
"tags": {
"type": "string",
"description": "A comma separated list indicating what tags, if any, should be used to filter the list of events."
},
"unaggregated": {
"type": "boolean",
"description": "Set unaggregated to `true` to return all events within the specified [`start`,`end`] timeframe. Otherwise if an event is aggregated to a parent event with a timestamp outside of the timeframe, it won't be available in the output. Aggregated events with `is_aggregate=true` in the response will still be returned unless exclude_aggregate is set to `true.`"
},
"exclude_aggregate": {
"type": "boolean",
"description": "Set `exclude_aggregate` to `true` to only return unaggregated events where `is_aggregate=false` in the response. If the `exclude_aggregate` parameter is set to `true`, then the unaggregated parameter is ignored and will be `true` by default."
},
"page": {
"type": "integer",
"description": "By default 1000 results are returned per request. Set page to the number of the page to return with `0` being the first page. The page parameter can only be used when either unaggregated or exclude_aggregate is set to `true.`"
}
},
"required": [
"PCID",
"start",
"end"
]
}
```
***
## datadog\_monitoring\_list\_incident\_attachments
List incident attachments
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ------------------------- | ------ | -------- | ------- | ------------------------------------------------------------------------------------- |
| `incident_id` | string | Yes | — | The UUID of the incident. |
| `filter[attachment_type]` | string | No | — | Filter attachments by type. Supported values are `1` (`postmortem`) and `2` (`link`). |
| `include` | string | No | — | Resource to include in the response. Supported value: `last_modified_by_user`. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"incident_id": {
"type": "string",
"description": "The UUID of the incident."
},
"filter[attachment_type]": {
"type": "string",
"description": "Filter attachments by type. Supported values are `1` (`postmortem`) and `2` (`link`)."
},
"include": {
"type": "string",
"description": "Resource to include in the response. Supported value: `last_modified_by_user`."
}
},
"required": [
"PCID",
"incident_id"
]
}
```
***
## datadog\_monitoring\_list\_incidents
Get a list of incidents
**Parameters:**
| Parameter | Type | Required | Default | Description |
| -------------- | --------- | -------- | ------- | ---------------------------------------------------------------------------- |
| `include` | string\[] | No | — | Specifies which types of related objects should be included in the response. |
| `page[size]` | integer | No | — | Size for a given page. The maximum allowed value is 100. |
| `page[offset]` | integer | No | — | Specific offset to use as the beginning of the returned page. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"include": {
"type": "array",
"items": {
"type": "string",
"enum": [
"users",
"attachments"
]
},
"description": "Specifies which types of related objects should be included in the response."
},
"page[size]": {
"type": "integer",
"description": "Size for a given page. The maximum allowed value is 100."
},
"page[offset]": {
"type": "integer",
"description": "Specific offset to use as the beginning of the returned page."
}
},
"required": [
"PCID"
]
}
```
***
## datadog\_monitoring\_list\_monitors
Get all monitors
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ---------------- | ------- | -------- | ------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `group_states` | string | No | — | When specified, shows additional information about the group states. Choose one or more from `all`, `alert`, `warn`, and `no data`. |
| `name` | string | No | — | A string to filter monitors by name. |
| `tags` | string | No | — | 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_tags` | string | No | — | 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_downtimes` | boolean | No | — | If this argument is set to true, then the returned data includes all current active downtimes for each monitor. |
| `id_offset` | integer | No | — | 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. |
| `page` | integer | No | — | The page to start paginating from. If this argument is not specified, the request returns all monitors without pagination. |
| `page_size` | integer | No | — | 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. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"group_states": {
"type": "string",
"description": "When specified, shows additional information about the group states. Choose one or more from `all`, `alert`, `warn`, and `no data`."
},
"name": {
"type": "string",
"description": "A string to filter monitors by name."
},
"tags": {
"type": "string",
"description": "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_tags": {
"type": "string",
"description": "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_downtimes": {
"type": "boolean",
"description": "If this argument is set to true, then the returned data includes all current active downtimes for each monitor."
},
"id_offset": {
"type": "integer",
"description": "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."
},
"page": {
"type": "integer",
"description": "The page to start paginating from. If this argument is not specified, the request returns all monitors without pagination."
},
"page_size": {
"type": "integer",
"description": "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."
}
},
"required": [
"PCID"
]
}
```
***
## datadog\_monitoring\_list\_slos
Get all SLOs
**Parameters:**
| Parameter | Type | Required | Default | Description |
| --------------- | ------- | -------- | ------- | -------------------------------------------------------------------------- |
| `ids` | string | No | — | A comma separated list of the IDs of the service level objectives objects. |
| `query` | string | No | — | The query string to filter results based on SLO names. |
| `tags_query` | string | No | — | The query string to filter results based on a single SLO tag. |
| `metrics_query` | string | No | — | The query string to filter results based on SLO numerator and denominator. |
| `limit` | integer | No | — | The number of SLOs to return in the response. |
| `offset` | integer | No | — | The specific offset to use as the beginning of the returned response. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"ids": {
"type": "string",
"description": "A comma separated list of the IDs of the service level objectives objects."
},
"query": {
"type": "string",
"description": "The query string to filter results based on SLO names."
},
"tags_query": {
"type": "string",
"description": "The query string to filter results based on a single SLO tag."
},
"metrics_query": {
"type": "string",
"description": "The query string to filter results based on SLO numerator and denominator."
},
"limit": {
"type": "integer",
"description": "The number of SLOs to return in the response."
},
"offset": {
"type": "integer",
"description": "The specific offset to use as the beginning of the returned response."
}
},
"required": [
"PCID"
]
}
```
***
## datadog\_monitoring\_search\_incidents
Search for incidents
**Parameters:**
| Parameter | Type | Required | Default | Description |
| -------------- | ------- | -------- | ------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `include` | string | No | — | Specifies which types of related objects should be included in the response. |
| `query` | string | Yes | — | Specifies which incidents should be returned. The query can contain any number of incident facets joined by `ANDs`, along with multiple values for each of those facets joined by `OR`s. For example: `state:active AND severity:(SEV-2 OR SEV-1)`. |
| `sort` | string | No | — | Specifies the order of returned incidents. |
| `page[size]` | integer | No | — | Size for a given page. The maximum allowed value is 100. |
| `page[offset]` | integer | No | — | Specific offset to use as the beginning of the returned page. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"include": {
"type": "string",
"description": "Specifies which types of related objects should be included in the response.",
"enum": [
"users",
"attachments"
]
},
"query": {
"type": "string",
"description": "Specifies which incidents should be returned. The query can contain any number of incident facets joined by `ANDs`, along with multiple values for each of those facets joined by `OR`s. For example: `state:active AND severity:(SEV-2 OR SEV-1)`."
},
"sort": {
"type": "string",
"description": "Specifies the order of returned incidents.",
"enum": [
"created",
"-created"
]
},
"page[size]": {
"type": "integer",
"description": "Size for a given page. The maximum allowed value is 100."
},
"page[offset]": {
"type": "integer",
"description": "Specific offset to use as the beginning of the returned page."
}
},
"required": [
"PCID",
"query"
]
}
```
***
## datadog\_monitoring\_search\_monitor\_groups
Monitors group search
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ---------- | ------- | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `query` | string | No | — | After entering a search query on the \[Triggered Monitors page]\[1], use the query parameter value in the URL of the page as a value for this parameter. For more information, see the \[Manage Monitors documentation]\[2]. The query can contain any number of space-separated monitor attributes, for instance: `query="type:metric group_status:alert"`. \[1]: [https://app.datadoghq.com/monitors/triggered](https://app.datadoghq.com/monitors/triggered) \[2]: /monitors/manage/#triggered-monitors |
| `page` | integer | No | — | Page to start paginating from. |
| `per_page` | integer | No | — | Number of monitors to return per page. |
| `sort` | string | No | — | String for sort order, composed of field and sort order separate by a comma, for example `name,asc`. Supported sort directions: `asc`, `desc`. Supported fields: \* `name` \* `status` \* `tags` |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"query": {
"type": "string",
"description": "After entering a search query on the [Triggered Monitors page][1], use the query parameter value in the URL of the page as a value for this parameter. For more information, see the [Manage Monitors documentation][2]. The query can contain any number of space-separated monitor attributes, for instance: `query=\"type:metric group_status:alert\"`. [1]: https://app.datadoghq.com/monitors/triggered [2]: /monitors/manage/#triggered-monitors"
},
"page": {
"type": "integer",
"description": "Page to start paginating from."
},
"per_page": {
"type": "integer",
"description": "Number of monitors to return per page."
},
"sort": {
"type": "string",
"description": "String for sort order, composed of field and sort order separate by a comma, for example `name,asc`. Supported sort directions: `asc`, `desc`. Supported fields: * `name` * `status` * `tags`"
}
},
"required": [
"PCID"
]
}
```
***
## datadog\_monitoring\_search\_monitors
Monitors search
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ---------- | ------- | -------- | ------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `query` | string | No | — | After entering a search query in your \[Manage Monitor page]\[1] use the query parameter value in the URL of the page as value for this parameter. Consult the dedicated \[manage monitor documentation]\[2] page to learn more. The query can contain any number of space-separated monitor attributes, for instance `query="type:metric status:alert"`. \[1]: [https://app.datadoghq.com/monitors/manage](https://app.datadoghq.com/monitors/manage) \[2]: /monitors/manage/#find-the-monitors |
| `page` | integer | No | — | Page to start paginating from. |
| `per_page` | integer | No | — | Number of monitors to return per page. |
| `sort` | string | No | — | String for sort order, composed of field and sort order separate by a comma, for example `name,asc`. Supported sort directions: `asc`, `desc`. Supported fields: \* `name` \* `status` \* `tags` |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"query": {
"type": "string",
"description": "After entering a search query in your [Manage Monitor page][1] use the query parameter value in the URL of the page as value for this parameter. Consult the dedicated [manage monitor documentation][2] page to learn more. The query can contain any number of space-separated monitor attributes, for instance `query=\"type:metric status:alert\"`. [1]: https://app.datadoghq.com/monitors/manage [2]: /monitors/manage/#find-the-monitors"
},
"page": {
"type": "integer",
"description": "Page to start paginating from."
},
"per_page": {
"type": "integer",
"description": "Number of monitors to return per page."
},
"sort": {
"type": "string",
"description": "String for sort order, composed of field and sort order separate by a comma, for example `name,asc`. Supported sort directions: `asc`, `desc`. Supported fields: * `name` * `status` * `tags`"
}
},
"required": [
"PCID"
]
}
```
***
## datadog\_monitoring\_update\_incident
Update an existing incident
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ------------- | --------- | -------- | ------- | ---------------------------------------------------------------------------- |
| `incident_id` | string | Yes | — | The UUID of the incident. |
| `include` | string\[] | No | — | Specifies which types of related objects should be included in the response. |
| `data` | object | Yes | — | Incident data for an update request. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"incident_id": {
"type": "string",
"description": "The UUID of the incident."
},
"include": {
"type": "array",
"items": {
"type": "string",
"enum": [
"users",
"attachments"
]
},
"description": "Specifies which types of related objects should be included in the response."
},
"data": {
"type": "object",
"description": "Incident data for an update request.",
"properties": {
"attributes": {
"type": "object",
"description": "The incident's attributes for an update request."
},
"id": {
"type": "string",
"description": "The incident's ID."
},
"relationships": {
"type": "object",
"description": "The incident's relationships for an update request."
},
"type": {
"type": "string",
"description": "Incident resource type.",
"enum": [
"incidents"
]
}
},
"required": [
"id",
"type"
]
}
},
"required": [
"PCID",
"incident_id",
"data"
]
}
```
***
## datadog\_monitoring\_update\_monitor
Edit a monitor
**Parameters:**
| Parameter | Type | Required | Default | Description | |
| ------------------ | --------- | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ----------------------------------------------------------- |
| `monitor_id` | integer | Yes | — | The ID of the monitor. | |
| `assets` | object\[] | No | — | The list of monitor assets tied to a monitor, which represents key links for users to take action on monitor alerts (for example, runbooks). | |
| `created` | string | No | — | Timestamp of the monitor creation. | |
| `creator` | object | No | — | Object describing the creator of the shared element. | |
| `deleted` | string | null | No | — | Whether or not the monitor is deleted. (Always `null`) |
| `draft_status` | string | No | — | 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. | |
| `id` | integer | No | — | ID of this monitor. | |
| `message` | string | No | — | A message to include with notifications for this monitor. | |
| `modified` | string | No | — | Last timestamp when the monitor was edited. | |
| `multi` | boolean | No | — | Whether or not the monitor is broken down on different groups. | |
| `name` | string | No | — | The monitor name. | |
| `options` | object | No | — | List of options associated with your monitor. | |
| `overall_state` | string | No | — | The different states your monitor can be in. | |
| `priority` | integer | null | No | — | Integer from 1 (high) to 5 (low) indicating alert severity. |
| `query` | string | No | — | The monitor query. | |
| `restricted_roles` | string\[] | No | — | 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](https://docs.datadoghq.com/api/latest/roles/#list-roles) 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](https://docs.datadoghq.com/api/latest/restriction-policies/) to manage write authorization for individual monitors by teams and users, in addition to roles. | |
| `state` | object | No | — | Wrapper object with the different monitor states. | |
| `tags` | string\[] | No | — | Tags associated to your monitor. | |
| `type` | string | No | — | The type of the monitor. For more information about `type`, see the [monitor options](https://docs.datadoghq.com/monitors/guide/monitor_api_options/) docs. | |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"monitor_id": {
"type": "integer",
"description": "The ID of the monitor."
},
"assets": {
"type": "array",
"items": {
"type": "object",
"properties": {
"category": {
"type": "string",
"enum": [
"runbook"
],
"description": "Indicates the type of asset this entity represents on a monitor."
},
"name": {
"type": "string",
"description": "Name for the monitor asset"
},
"resource_key": {
"type": "string",
"description": "Represents the identifier of the internal Datadog resource that this asset represents. IDs in this field should be passed in as strings."
},
"resource_type": {
"type": "string",
"enum": [
"notebook"
],
"description": "Type of internal Datadog resource associated with a monitor asset."
},
"url": {
"type": "string",
"description": "URL link for the asset. For links with an internal resource type set, this should be the relative path to where the Datadog domain is appended internally. For external links, this should be the full URL path."
}
},
"required": [
"name",
"url",
"category"
]
},
"description": "The list of monitor assets tied to a monitor, which represents key links for users to take action on monitor alerts (for example, runbooks)."
},
"created": {
"type": "string",
"description": "Timestamp of the monitor creation."
},
"creator": {
"type": "object",
"description": "Object describing the creator of the shared element.",
"properties": {
"email": {
"type": "string",
"description": "Email of the creator."
},
"handle": {
"type": "string",
"description": "Handle of the creator."
},
"name": {
"type": "string",
"description": "Name of the creator."
}
}
},
"deleted": {
"type": [
"string",
"null"
],
"description": "Whether or not the monitor is deleted. (Always `null`)"
},
"draft_status": {
"type": "string",
"description": "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.",
"enum": [
"draft",
"published"
]
},
"id": {
"type": "integer",
"description": "ID of this monitor."
},
"message": {
"type": "string",
"description": "A message to include with notifications for this monitor."
},
"modified": {
"type": "string",
"description": "Last timestamp when the monitor was edited."
},
"multi": {
"type": "boolean",
"description": "Whether or not the monitor is broken down on different groups."
},
"name": {
"type": "string",
"description": "The monitor name."
},
"options": {
"type": "object",
"description": "List of options associated with your monitor.",
"properties": {
"aggregation": {
"type": "object",
"description": "Type of aggregation performed in the monitor query."
},
"device_ids": {
"type": "array",
"items": {
"type": "string",
"enum": [
"laptop_large",
"tablet",
"mobile_small",
"chrome.laptop_large",
"chrome.tablet",
"chrome.mobile_small",
"firefox.laptop_large",
"firefox.tablet",
"firefox.mobile_small"
]
},
"description": "IDs of the device the Synthetics monitor is running on."
},
"enable_logs_sample": {
"type": "boolean",
"description": "Whether or not to send a log sample when the log monitor triggers."
},
"enable_samples": {
"type": "boolean",
"description": "Whether or not to send a list of samples when the monitor triggers. This is only used by CI Test and Pipeline monitors."
},
"escalation_message": {
"type": "string",
"description": "We recommend using the [is_renotify](https://docs.datadoghq.com/monitors/notify/?tab=is_alert#renotify), block in the original message instead. A message to include with a re-notification. Supports the `@username` notification we allow elsewhere. Not applicable if `renotify_interval` is `None`."
},
"evaluation_delay": {
"type": "integer",
"description": "Time (in seconds) to delay evaluation, as a non-negative integer. For example, if the value is set to `300` (5min), the timeframe is set to `last_5m` and the time is 7:00, the monitor evaluates data from 6:50 to 6:55. This is useful for AWS CloudWatch and other backfilled metrics to ensure the monitor always has data during evaluation."
},
"group_retention_duration": {
"type": "string",
"description": "The time span after which groups with missing data are dropped from the monitor state. The minimum value is one hour, and the maximum value is 72 hours. Example values are: \"60m\", \"1h\", and \"2d\". This option is only available for APM Trace Analytics, Audit Trail, CI, Error Tracking, Event, Logs, and RUM monitors."
},
"groupby_simple_monitor": {
"type": "boolean",
"description": "Whether the log alert monitor triggers a single alert or multiple alerts when any group breaches a threshold. Use `notify_by` instead."
},
"include_tags": {
"type": "boolean",
"description": "A Boolean indicating whether notifications from this monitor automatically inserts its triggering tags into the title. **Examples** - If `True`, `[Triggered on {host:h1}] Monitor Title` - If `False`, `[Triggered] Monitor Title`"
},
"locked": {
"type": "boolean",
"description": "Whether or not the monitor is locked (only editable by creator and admins). Use `restricted_roles` instead."
},
"min_failure_duration": {
"type": "integer",
"description": "How long the test should be in failure before alerting (integer, number of seconds, max 7200)."
},
"min_location_failed": {
"type": "integer",
"description": "The minimum number of locations in failure at the same time during at least one moment in the `min_failure_duration` period (`min_location_failed` and `min_failure_duration` are part of the advanced alerting rules - integer, >= 1)."
},
"new_group_delay": {
"type": "integer",
"description": "Time (in seconds) to skip evaluations for new groups. For example, this option can be used to skip evaluations for new hosts while they initialize. Must be a non negative integer."
},
"new_host_delay": {
"type": "integer",
"description": "Time (in seconds) to allow a host to boot and applications to fully start before starting the evaluation of monitor results. Should be a non negative integer. Use new_group_delay instead."
},
"no_data_timeframe": {
"type": "integer",
"description": "The number of minutes before a monitor notifies after data stops reporting. Datadog recommends at least 2x the monitor timeframe for query alerts or 2 minutes for service checks. If omitted, 2x the evaluation timeframe is used for query alerts, and 24 hours is used for service checks."
},
"notification_preset_name": {
"type": "string",
"description": "Toggles the display of additional content sent in the monitor notification.",
"enum": [
"show_all",
"hide_query",
"hide_handles",
"hide_all",
"hide_query_and_handles",
"show_only_snapshot",
"hide_handles_and_footer"
]
},
"notify_audit": {
"type": "boolean",
"description": "A Boolean indicating whether tagged users is notified on changes to this monitor."
},
"notify_by": {
"type": "array",
"items": {
"type": "string"
},
"description": "Controls what granularity a monitor alerts on. Only available for monitors with groupings. For instance, a monitor grouped by `cluster`, `namespace`, and `pod` can be configured to only notify on each new `cluster` violating the alert conditions by setting `notify_by` to `[\"cluster\"]`. Tags mentioned in `notify_by` must be a subset of the grouping tags in the query. For example, a query grouped by `cluster` and `namespace` cannot notify on `region`. Setting `notify_by` to `[\"*\"]` configures the monitor to notify as a simple-alert."
},
"notify_no_data": {
"type": "boolean",
"description": "A Boolean indicating whether this monitor notifies when data stops reporting. Defaults to `false`."
},
"on_missing_data": {
"type": "string",
"description": "Controls how groups or monitors are treated if an evaluation does not return any data points. The default option results in different behavior depending on the monitor query type. For monitors using Count queries, an empty monitor evaluation is treated as 0 and is compared to the threshold conditions. For monitors using any query type other than Count, for example Gauge, Measure, or Rate, the monitor shows the last known status. This option is only available for APM Trace Analytics, Audit Trail, CI, Error Tracking, Event, Logs, and RUM monitors.",
"enum": [
"default",
"show_no_data",
"show_and_notify_no_data",
"resolve"
]
},
"renotify_interval": {
"type": "integer",
"description": "The number of minutes after the last notification before a monitor re-notifies on the current status. It only re-notifies if it’s not resolved."
},
"renotify_occurrences": {
"type": "integer",
"description": "The number of times re-notification messages should be sent on the current status at the provided re-notification interval."
},
"renotify_statuses": {
"type": "array",
"items": {
"type": "string",
"enum": [
"alert",
"warn",
"no data"
]
},
"description": "The types of monitor statuses for which re-notification messages are sent. Default: **null** if `renotify_interval` is **null**. If `renotify_interval` is set, defaults to renotify on `Alert` and `No Data`."
},
"require_full_window": {
"type": "boolean",
"description": "A Boolean indicating whether this monitor needs a full window of data before it’s evaluated. We highly recommend you set this to `false` for sparse metrics, otherwise some evaluations are skipped. Default is false. This setting only applies to metric monitors."
},
"scheduling_options": {
"type": "object",
"description": "Configuration options for scheduling."
},
"silenced": {
"type": "object",
"description": "Information about the downtime applied to the monitor. Only shows v1 downtimes."
},
"synthetics_check_id": {
"type": "string",
"description": "ID of the corresponding Synthetic check."
},
"threshold_windows": {
"type": "object",
"description": "Alerting time window options."
},
"thresholds": {
"type": "object",
"description": "List of the different monitor threshold available."
},
"timeout_h": {
"type": "integer",
"description": "The number of hours of the monitor not reporting data before it automatically resolves from a triggered state. The minimum allowed value is 0 hours. The maximum allowed value is 24 hours."
},
"variables": {
"type": "array",
"description": "List of requests that can be used in the monitor query. **This feature is currently in beta.**"
}
}
},
"overall_state": {
"type": "string",
"description": "The different states your monitor can be in.",
"enum": [
"Alert",
"Ignored",
"No Data",
"OK",
"Skipped",
"Unknown",
"Warn"
]
},
"priority": {
"type": [
"integer",
"null"
],
"description": "Integer from 1 (high) to 5 (low) indicating alert severity."
},
"query": {
"type": "string",
"description": "The monitor query."
},
"restricted_roles": {
"type": "array",
"items": {
"type": "string"
},
"description": "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](https://docs.datadoghq.com/api/latest/roles/#list-roles) 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](https://docs.datadoghq.com/api/latest/restriction-policies/) to manage write authorization for individual monitors by teams and users, in addition to roles."
},
"state": {
"type": "object",
"description": "Wrapper object with the different monitor states.",
"properties": {
"groups": {
"type": "object",
"description": "Dictionary where the keys are groups (comma separated lists of tags) and the values are the list of groups your monitor is broken down on."
}
}
},
"tags": {
"type": "array",
"items": {
"type": "string"
},
"description": "Tags associated to your monitor."
},
"type": {
"type": "string",
"description": "The type of the monitor. For more information about `type`, see the [monitor options](https://docs.datadoghq.com/monitors/guide/monitor_api_options/) docs.",
"enum": [
"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"
]
}
},
"required": [
"PCID",
"monitor_id"
]
}
```
***
## datadog\_monitoring\_update\_slo
Update an SLO
**Parameters:**
| Parameter | Type | Required | Default | Description | |
| ------------------- | ---------- | -------- | ------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `slo_id` | string | Yes | — | The ID of the service level objective object. | |
| `created_at` | integer | No | — | Creation timestamp (UNIX time in seconds) Always included in service level objective responses. | |
| `creator` | object | No | — | Object describing the creator of the shared element. | |
| `description` | string | null | No | — | A user-defined description of the service level objective. Always included in service level objective responses (but may be `null`). Optional in create/update requests. |
| `groups` | string\[] | No | — | A list of (up to 100) monitor groups that narrow the scope of a monitor service level objective. Included in service level objective responses if it is not empty. Optional in create/update requests for monitor service level objectives, but may only be used when then length of the `monitor_ids` field is one. | |
| `id` | string | No | — | A unique identifier for the service level objective object. Always included in service level objective responses. | |
| `modified_at` | integer | No | — | Modification timestamp (UNIX time in seconds) Always included in service level objective responses. | |
| `monitor_ids` | integer\[] | No | — | A list of monitor ids that defines the scope of a monitor service level objective. **Required if type is `monitor`**. | |
| `monitor_tags` | string\[] | No | — | The union of monitor tags for all monitors referenced by the `monitor_ids` field. Always included in service level objective responses for monitor-based service level objectives (but may be empty). Ignored in create/update requests. Does not affect which monitors are included in the service level objective (that is determined entirely by the `monitor_ids` field). | |
| `name` | string | Yes | — | The name of the service level objective object. | |
| `query` | object | No | — | A count-based (metric) SLO query. This field is superseded by `sli_specification` but is retained for backwards compatibility. Note that Datadog only allows the sum by aggregator to be used because this will sum up all request counts instead of averaging them, or taking the max or min of all of those requests. | |
| `sli_specification` | object | No | — | A generic SLI specification. This is used for time-slice and count-based (metric) SLOs only. | |
| `tags` | string\[] | No | — | A list of tags associated with this service level objective. Always included in service level objective responses (but may be empty). Optional in create/update requests. | |
| `target_threshold` | number | No | — | The target threshold such that when the service level indicator is above this threshold over the given timeframe, the objective is being met. | |
| `thresholds` | object\[] | Yes | — | The thresholds (timeframes and associated targets) for this service level objective object. | |
| `timeframe` | string | No | — | The SLO time window options. Note that "custom" is not a valid option for creating or updating SLOs. It is only used when querying SLO history over custom timeframes. | |
| `type` | string | Yes | — | The type of the service level objective. | |
| `warning_threshold` | number | No | — | The optional warning threshold such that when the service level indicator is below this value for the given threshold, but above the target threshold, the objective appears in a "warning" state. This value must be greater than the target threshold. | |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"slo_id": {
"type": "string",
"description": "The ID of the service level objective object."
},
"created_at": {
"type": "integer",
"description": "Creation timestamp (UNIX time in seconds) Always included in service level objective responses."
},
"creator": {
"type": "object",
"description": "Object describing the creator of the shared element.",
"properties": {
"email": {
"type": "string",
"description": "Email of the creator."
},
"handle": {
"type": "string",
"description": "Handle of the creator."
},
"name": {
"type": "string",
"description": "Name of the creator."
}
}
},
"description": {
"type": [
"string",
"null"
],
"description": "A user-defined description of the service level objective. Always included in service level objective responses (but may be `null`). Optional in create/update requests."
},
"groups": {
"type": "array",
"items": {
"type": "string"
},
"description": "A list of (up to 100) monitor groups that narrow the scope of a monitor service level objective. Included in service level objective responses if it is not empty. Optional in create/update requests for monitor service level objectives, but may only be used when then length of the `monitor_ids` field is one."
},
"id": {
"type": "string",
"description": "A unique identifier for the service level objective object. Always included in service level objective responses."
},
"modified_at": {
"type": "integer",
"description": "Modification timestamp (UNIX time in seconds) Always included in service level objective responses."
},
"monitor_ids": {
"type": "array",
"items": {
"type": "integer",
"format": "int64"
},
"description": "A list of monitor ids that defines the scope of a monitor service level objective. **Required if type is `monitor`**."
},
"monitor_tags": {
"type": "array",
"items": {
"type": "string"
},
"description": "The union of monitor tags for all monitors referenced by the `monitor_ids` field. Always included in service level objective responses for monitor-based service level objectives (but may be empty). Ignored in create/update requests. Does not affect which monitors are included in the service level objective (that is determined entirely by the `monitor_ids` field)."
},
"name": {
"type": "string",
"description": "The name of the service level objective object."
},
"query": {
"type": "object",
"description": "A count-based (metric) SLO query. This field is superseded by `sli_specification` but is retained for backwards compatibility. Note that Datadog only allows the sum by aggregator to be used because this will sum up all request counts instead of averaging them, or taking the max or min of all of those requests.",
"properties": {
"denominator": {
"type": "string",
"description": "A Datadog metric query for total (valid) events."
},
"numerator": {
"type": "string",
"description": "A Datadog metric query for good events."
}
},
"required": [
"numerator",
"denominator"
]
},
"sli_specification": {
"description": "A generic SLI specification. This is used for time-slice and count-based (metric) SLOs only."
},
"tags": {
"type": "array",
"items": {
"type": "string"
},
"description": "A list of tags associated with this service level objective. Always included in service level objective responses (but may be empty). Optional in create/update requests."
},
"target_threshold": {
"type": "number",
"description": "The target threshold such that when the service level indicator is above this threshold over the given timeframe, the objective is being met."
},
"thresholds": {
"type": "array",
"items": {
"type": "object",
"properties": {
"target": {
"type": "number",
"format": "double",
"description": "The target value for the service level indicator within the corresponding timeframe."
},
"target_display": {
"type": "string",
"description": "A string representation of the target that indicates its precision. It uses trailing zeros to show significant decimal places (for example `98.00`). Always included in service level objective responses. Ignored in create/update requests."
},
"timeframe": {
"type": "string",
"enum": [
"7d",
"30d",
"90d",
"custom"
],
"description": "The SLO time window options. Note that \"custom\" is not a valid option for creating or updating SLOs. It is only used when querying SLO history over custom timeframes."
},
"warning": {
"type": "number",
"format": "double",
"description": "The warning value for the service level objective."
},
"warning_display": {
"type": "string",
"description": "A string representation of the warning target (see the description of the `target_display` field for details). Included in service level objective responses if a warning target exists. Ignored in create/update requests."
}
},
"required": [
"timeframe",
"target"
]
},
"description": "The thresholds (timeframes and associated targets) for this service level objective object."
},
"timeframe": {
"type": "string",
"description": "The SLO time window options. Note that \"custom\" is not a valid option for creating or updating SLOs. It is only used when querying SLO history over custom timeframes.",
"enum": [
"7d",
"30d",
"90d",
"custom"
]
},
"type": {
"type": "string",
"description": "The type of the service level objective.",
"enum": [
"metric",
"monitor",
"time_slice"
]
},
"warning_threshold": {
"type": "number",
"description": "The optional warning threshold such that when the service level indicator is below this value for the given threshold, but above the target threshold, the objective appears in a \"warning\" state. This value must be greater than the target threshold."
}
},
"required": [
"PCID",
"slo_id",
"name",
"thresholds",
"type"
]
}
```
***
## datadog\_monitoring\_validate\_existing\_monitor
Validate an existing monitor
**Parameters:**
| Parameter | Type | Required | Default | Description | |
| -------------------- | --------- | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ----------------------------------------------------------- |
| `monitor_id` | integer | Yes | — | The ID of the monitor | |
| `assets` | object\[] | No | — | The list of monitor assets tied to a monitor, which represents key links for users to take action on monitor alerts (for example, runbooks). | |
| `created` | string | No | — | Timestamp of the monitor creation. | |
| `creator` | object | No | — | Object describing the creator of the shared element. | |
| `deleted` | string | null | No | — | Whether or not the monitor is deleted. (Always `null`) |
| `draft_status` | string | No | — | 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. | |
| `id` | integer | No | — | ID of this monitor. | |
| `matching_downtimes` | object\[] | No | — | A list of active v1 downtimes that match this monitor. | |
| `message` | string | No | — | A message to include with notifications for this monitor. | |
| `modified` | string | No | — | Last timestamp when the monitor was edited. | |
| `multi` | boolean | No | — | Whether or not the monitor is broken down on different groups. | |
| `name` | string | No | — | The monitor name. | |
| `options` | object | No | — | List of options associated with your monitor. | |
| `overall_state` | string | No | — | The different states your monitor can be in. | |
| `priority` | integer | null | No | — | Integer from 1 (high) to 5 (low) indicating alert severity. |
| `query` | string | Yes | — | The monitor query. | |
| `restricted_roles` | string\[] | No | — | 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](https://docs.datadoghq.com/api/latest/roles/#list-roles) 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](https://docs.datadoghq.com/api/latest/restriction-policies/) to manage write authorization for individual monitors by teams and users, in addition to roles. | |
| `state` | object | No | — | Wrapper object with the different monitor states. | |
| `tags` | string\[] | No | — | Tags associated to your monitor. | |
| `type` | string | Yes | — | The type of the monitor. For more information about `type`, see the [monitor options](https://docs.datadoghq.com/monitors/guide/monitor_api_options/) docs. | |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"monitor_id": {
"type": "integer",
"description": "The ID of the monitor"
},
"assets": {
"type": "array",
"items": {
"type": "object",
"properties": {
"category": {
"type": "string",
"enum": [
"runbook"
],
"description": "Indicates the type of asset this entity represents on a monitor."
},
"name": {
"type": "string",
"description": "Name for the monitor asset"
},
"resource_key": {
"type": "string",
"description": "Represents the identifier of the internal Datadog resource that this asset represents. IDs in this field should be passed in as strings."
},
"resource_type": {
"type": "string",
"enum": [
"notebook"
],
"description": "Type of internal Datadog resource associated with a monitor asset."
},
"url": {
"type": "string",
"description": "URL link for the asset. For links with an internal resource type set, this should be the relative path to where the Datadog domain is appended internally. For external links, this should be the full URL path."
}
},
"required": [
"name",
"url",
"category"
]
},
"description": "The list of monitor assets tied to a monitor, which represents key links for users to take action on monitor alerts (for example, runbooks)."
},
"created": {
"type": "string",
"description": "Timestamp of the monitor creation."
},
"creator": {
"type": "object",
"description": "Object describing the creator of the shared element.",
"properties": {
"email": {
"type": "string",
"description": "Email of the creator."
},
"handle": {
"type": "string",
"description": "Handle of the creator."
},
"name": {
"type": "string",
"description": "Name of the creator."
}
}
},
"deleted": {
"type": [
"string",
"null"
],
"description": "Whether or not the monitor is deleted. (Always `null`)"
},
"draft_status": {
"type": "string",
"description": "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.",
"enum": [
"draft",
"published"
]
},
"id": {
"type": "integer",
"description": "ID of this monitor."
},
"matching_downtimes": {
"type": "array",
"items": {
"type": "object",
"properties": {
"end": {
"type": "integer",
"format": "int64",
"description": "POSIX timestamp to end the downtime."
},
"id": {
"type": "integer",
"format": "int64",
"description": "The downtime ID."
},
"scope": {
"type": "array",
"items": {
"type": "string"
},
"description": "The scope(s) to which the downtime applies. Must be in `key:value` format. For example, `host:app2`. Provide multiple scopes as a comma-separated list like `env:dev,env:prod`. The resulting downtime applies to sources that matches ALL provided scopes (`env:dev` **AND** `env:prod`)."
},
"start": {
"type": "integer",
"format": "int64",
"description": "POSIX timestamp to start the downtime."
}
},
"required": [
"id"
]
},
"description": "A list of active v1 downtimes that match this monitor."
},
"message": {
"type": "string",
"description": "A message to include with notifications for this monitor."
},
"modified": {
"type": "string",
"description": "Last timestamp when the monitor was edited."
},
"multi": {
"type": "boolean",
"description": "Whether or not the monitor is broken down on different groups."
},
"name": {
"type": "string",
"description": "The monitor name."
},
"options": {
"type": "object",
"description": "List of options associated with your monitor.",
"properties": {
"aggregation": {
"type": "object",
"description": "Type of aggregation performed in the monitor query."
},
"device_ids": {
"type": "array",
"items": {
"type": "string",
"enum": [
"laptop_large",
"tablet",
"mobile_small",
"chrome.laptop_large",
"chrome.tablet",
"chrome.mobile_small",
"firefox.laptop_large",
"firefox.tablet",
"firefox.mobile_small"
]
},
"description": "IDs of the device the Synthetics monitor is running on."
},
"enable_logs_sample": {
"type": "boolean",
"description": "Whether or not to send a log sample when the log monitor triggers."
},
"enable_samples": {
"type": "boolean",
"description": "Whether or not to send a list of samples when the monitor triggers. This is only used by CI Test and Pipeline monitors."
},
"escalation_message": {
"type": "string",
"description": "We recommend using the [is_renotify](https://docs.datadoghq.com/monitors/notify/?tab=is_alert#renotify), block in the original message instead. A message to include with a re-notification. Supports the `@username` notification we allow elsewhere. Not applicable if `renotify_interval` is `None`."
},
"evaluation_delay": {
"type": "integer",
"description": "Time (in seconds) to delay evaluation, as a non-negative integer. For example, if the value is set to `300` (5min), the timeframe is set to `last_5m` and the time is 7:00, the monitor evaluates data from 6:50 to 6:55. This is useful for AWS CloudWatch and other backfilled metrics to ensure the monitor always has data during evaluation."
},
"group_retention_duration": {
"type": "string",
"description": "The time span after which groups with missing data are dropped from the monitor state. The minimum value is one hour, and the maximum value is 72 hours. Example values are: \"60m\", \"1h\", and \"2d\". This option is only available for APM Trace Analytics, Audit Trail, CI, Error Tracking, Event, Logs, and RUM monitors."
},
"groupby_simple_monitor": {
"type": "boolean",
"description": "Whether the log alert monitor triggers a single alert or multiple alerts when any group breaches a threshold. Use `notify_by` instead."
},
"include_tags": {
"type": "boolean",
"description": "A Boolean indicating whether notifications from this monitor automatically inserts its triggering tags into the title. **Examples** - If `True`, `[Triggered on {host:h1}] Monitor Title` - If `False`, `[Triggered] Monitor Title`"
},
"locked": {
"type": "boolean",
"description": "Whether or not the monitor is locked (only editable by creator and admins). Use `restricted_roles` instead."
},
"min_failure_duration": {
"type": "integer",
"description": "How long the test should be in failure before alerting (integer, number of seconds, max 7200)."
},
"min_location_failed": {
"type": "integer",
"description": "The minimum number of locations in failure at the same time during at least one moment in the `min_failure_duration` period (`min_location_failed` and `min_failure_duration` are part of the advanced alerting rules - integer, >= 1)."
},
"new_group_delay": {
"type": "integer",
"description": "Time (in seconds) to skip evaluations for new groups. For example, this option can be used to skip evaluations for new hosts while they initialize. Must be a non negative integer."
},
"new_host_delay": {
"type": "integer",
"description": "Time (in seconds) to allow a host to boot and applications to fully start before starting the evaluation of monitor results. Should be a non negative integer. Use new_group_delay instead."
},
"no_data_timeframe": {
"type": "integer",
"description": "The number of minutes before a monitor notifies after data stops reporting. Datadog recommends at least 2x the monitor timeframe for query alerts or 2 minutes for service checks. If omitted, 2x the evaluation timeframe is used for query alerts, and 24 hours is used for service checks."
},
"notification_preset_name": {
"type": "string",
"description": "Toggles the display of additional content sent in the monitor notification.",
"enum": [
"show_all",
"hide_query",
"hide_handles",
"hide_all",
"hide_query_and_handles",
"show_only_snapshot",
"hide_handles_and_footer"
]
},
"notify_audit": {
"type": "boolean",
"description": "A Boolean indicating whether tagged users is notified on changes to this monitor."
},
"notify_by": {
"type": "array",
"items": {
"type": "string"
},
"description": "Controls what granularity a monitor alerts on. Only available for monitors with groupings. For instance, a monitor grouped by `cluster`, `namespace`, and `pod` can be configured to only notify on each new `cluster` violating the alert conditions by setting `notify_by` to `[\"cluster\"]`. Tags mentioned in `notify_by` must be a subset of the grouping tags in the query. For example, a query grouped by `cluster` and `namespace` cannot notify on `region`. Setting `notify_by` to `[\"*\"]` configures the monitor to notify as a simple-alert."
},
"notify_no_data": {
"type": "boolean",
"description": "A Boolean indicating whether this monitor notifies when data stops reporting. Defaults to `false`."
},
"on_missing_data": {
"type": "string",
"description": "Controls how groups or monitors are treated if an evaluation does not return any data points. The default option results in different behavior depending on the monitor query type. For monitors using Count queries, an empty monitor evaluation is treated as 0 and is compared to the threshold conditions. For monitors using any query type other than Count, for example Gauge, Measure, or Rate, the monitor shows the last known status. This option is only available for APM Trace Analytics, Audit Trail, CI, Error Tracking, Event, Logs, and RUM monitors.",
"enum": [
"default",
"show_no_data",
"show_and_notify_no_data",
"resolve"
]
},
"renotify_interval": {
"type": "integer",
"description": "The number of minutes after the last notification before a monitor re-notifies on the current status. It only re-notifies if it’s not resolved."
},
"renotify_occurrences": {
"type": "integer",
"description": "The number of times re-notification messages should be sent on the current status at the provided re-notification interval."
},
"renotify_statuses": {
"type": "array",
"items": {
"type": "string",
"enum": [
"alert",
"warn",
"no data"
]
},
"description": "The types of monitor statuses for which re-notification messages are sent. Default: **null** if `renotify_interval` is **null**. If `renotify_interval` is set, defaults to renotify on `Alert` and `No Data`."
},
"require_full_window": {
"type": "boolean",
"description": "A Boolean indicating whether this monitor needs a full window of data before it’s evaluated. We highly recommend you set this to `false` for sparse metrics, otherwise some evaluations are skipped. Default is false. This setting only applies to metric monitors."
},
"scheduling_options": {
"type": "object",
"description": "Configuration options for scheduling."
},
"silenced": {
"type": "object",
"description": "Information about the downtime applied to the monitor. Only shows v1 downtimes."
},
"synthetics_check_id": {
"type": "string",
"description": "ID of the corresponding Synthetic check."
},
"threshold_windows": {
"type": "object",
"description": "Alerting time window options."
},
"thresholds": {
"type": "object",
"description": "List of the different monitor threshold available."
},
"timeout_h": {
"type": "integer",
"description": "The number of hours of the monitor not reporting data before it automatically resolves from a triggered state. The minimum allowed value is 0 hours. The maximum allowed value is 24 hours."
},
"variables": {
"type": "array",
"description": "List of requests that can be used in the monitor query. **This feature is currently in beta.**"
}
}
},
"overall_state": {
"type": "string",
"description": "The different states your monitor can be in.",
"enum": [
"Alert",
"Ignored",
"No Data",
"OK",
"Skipped",
"Unknown",
"Warn"
]
},
"priority": {
"type": [
"integer",
"null"
],
"description": "Integer from 1 (high) to 5 (low) indicating alert severity."
},
"query": {
"type": "string",
"description": "The monitor query."
},
"restricted_roles": {
"type": "array",
"items": {
"type": "string"
},
"description": "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](https://docs.datadoghq.com/api/latest/roles/#list-roles) 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](https://docs.datadoghq.com/api/latest/restriction-policies/) to manage write authorization for individual monitors by teams and users, in addition to roles."
},
"state": {
"type": "object",
"description": "Wrapper object with the different monitor states.",
"properties": {
"groups": {
"type": "object",
"description": "Dictionary where the keys are groups (comma separated lists of tags) and the values are the list of groups your monitor is broken down on."
}
}
},
"tags": {
"type": "array",
"items": {
"type": "string"
},
"description": "Tags associated to your monitor."
},
"type": {
"type": "string",
"description": "The type of the monitor. For more information about `type`, see the [monitor options](https://docs.datadoghq.com/monitors/guide/monitor_api_options/) docs.",
"enum": [
"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"
]
}
},
"required": [
"PCID",
"monitor_id",
"query",
"type"
]
}
```
***
## datadog\_monitoring\_validate\_monitor
Validate a monitor
**Parameters:**
| Parameter | Type | Required | Default | Description | |
| -------------------- | --------- | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ----------------------------------------------------------- |
| `assets` | object\[] | No | — | The list of monitor assets tied to a monitor, which represents key links for users to take action on monitor alerts (for example, runbooks). | |
| `created` | string | No | — | Timestamp of the monitor creation. | |
| `creator` | object | No | — | Object describing the creator of the shared element. | |
| `deleted` | string | null | No | — | Whether or not the monitor is deleted. (Always `null`) |
| `draft_status` | string | No | — | 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. | |
| `id` | integer | No | — | ID of this monitor. | |
| `matching_downtimes` | object\[] | No | — | A list of active v1 downtimes that match this monitor. | |
| `message` | string | No | — | A message to include with notifications for this monitor. | |
| `modified` | string | No | — | Last timestamp when the monitor was edited. | |
| `multi` | boolean | No | — | Whether or not the monitor is broken down on different groups. | |
| `name` | string | No | — | The monitor name. | |
| `options` | object | No | — | List of options associated with your monitor. | |
| `overall_state` | string | No | — | The different states your monitor can be in. | |
| `priority` | integer | null | No | — | Integer from 1 (high) to 5 (low) indicating alert severity. |
| `query` | string | Yes | — | The monitor query. | |
| `restricted_roles` | string\[] | No | — | 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](https://docs.datadoghq.com/api/latest/roles/#list-roles) 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](https://docs.datadoghq.com/api/latest/restriction-policies/) to manage write authorization for individual monitors by teams and users, in addition to roles. | |
| `state` | object | No | — | Wrapper object with the different monitor states. | |
| `tags` | string\[] | No | — | Tags associated to your monitor. | |
| `type` | string | Yes | — | The type of the monitor. For more information about `type`, see the [monitor options](https://docs.datadoghq.com/monitors/guide/monitor_api_options/) docs. | |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"assets": {
"type": "array",
"items": {
"type": "object",
"properties": {
"category": {
"type": "string",
"enum": [
"runbook"
],
"description": "Indicates the type of asset this entity represents on a monitor."
},
"name": {
"type": "string",
"description": "Name for the monitor asset"
},
"resource_key": {
"type": "string",
"description": "Represents the identifier of the internal Datadog resource that this asset represents. IDs in this field should be passed in as strings."
},
"resource_type": {
"type": "string",
"enum": [
"notebook"
],
"description": "Type of internal Datadog resource associated with a monitor asset."
},
"url": {
"type": "string",
"description": "URL link for the asset. For links with an internal resource type set, this should be the relative path to where the Datadog domain is appended internally. For external links, this should be the full URL path."
}
},
"required": [
"name",
"url",
"category"
]
},
"description": "The list of monitor assets tied to a monitor, which represents key links for users to take action on monitor alerts (for example, runbooks)."
},
"created": {
"type": "string",
"description": "Timestamp of the monitor creation."
},
"creator": {
"type": "object",
"description": "Object describing the creator of the shared element.",
"properties": {
"email": {
"type": "string",
"description": "Email of the creator."
},
"handle": {
"type": "string",
"description": "Handle of the creator."
},
"name": {
"type": "string",
"description": "Name of the creator."
}
}
},
"deleted": {
"type": [
"string",
"null"
],
"description": "Whether or not the monitor is deleted. (Always `null`)"
},
"draft_status": {
"type": "string",
"description": "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.",
"enum": [
"draft",
"published"
]
},
"id": {
"type": "integer",
"description": "ID of this monitor."
},
"matching_downtimes": {
"type": "array",
"items": {
"type": "object",
"properties": {
"end": {
"type": "integer",
"format": "int64",
"description": "POSIX timestamp to end the downtime."
},
"id": {
"type": "integer",
"format": "int64",
"description": "The downtime ID."
},
"scope": {
"type": "array",
"items": {
"type": "string"
},
"description": "The scope(s) to which the downtime applies. Must be in `key:value` format. For example, `host:app2`. Provide multiple scopes as a comma-separated list like `env:dev,env:prod`. The resulting downtime applies to sources that matches ALL provided scopes (`env:dev` **AND** `env:prod`)."
},
"start": {
"type": "integer",
"format": "int64",
"description": "POSIX timestamp to start the downtime."
}
},
"required": [
"id"
]
},
"description": "A list of active v1 downtimes that match this monitor."
},
"message": {
"type": "string",
"description": "A message to include with notifications for this monitor."
},
"modified": {
"type": "string",
"description": "Last timestamp when the monitor was edited."
},
"multi": {
"type": "boolean",
"description": "Whether or not the monitor is broken down on different groups."
},
"name": {
"type": "string",
"description": "The monitor name."
},
"options": {
"type": "object",
"description": "List of options associated with your monitor.",
"properties": {
"aggregation": {
"type": "object",
"description": "Type of aggregation performed in the monitor query."
},
"device_ids": {
"type": "array",
"items": {
"type": "string",
"enum": [
"laptop_large",
"tablet",
"mobile_small",
"chrome.laptop_large",
"chrome.tablet",
"chrome.mobile_small",
"firefox.laptop_large",
"firefox.tablet",
"firefox.mobile_small"
]
},
"description": "IDs of the device the Synthetics monitor is running on."
},
"enable_logs_sample": {
"type": "boolean",
"description": "Whether or not to send a log sample when the log monitor triggers."
},
"enable_samples": {
"type": "boolean",
"description": "Whether or not to send a list of samples when the monitor triggers. This is only used by CI Test and Pipeline monitors."
},
"escalation_message": {
"type": "string",
"description": "We recommend using the [is_renotify](https://docs.datadoghq.com/monitors/notify/?tab=is_alert#renotify), block in the original message instead. A message to include with a re-notification. Supports the `@username` notification we allow elsewhere. Not applicable if `renotify_interval` is `None`."
},
"evaluation_delay": {
"type": "integer",
"description": "Time (in seconds) to delay evaluation, as a non-negative integer. For example, if the value is set to `300` (5min), the timeframe is set to `last_5m` and the time is 7:00, the monitor evaluates data from 6:50 to 6:55. This is useful for AWS CloudWatch and other backfilled metrics to ensure the monitor always has data during evaluation."
},
"group_retention_duration": {
"type": "string",
"description": "The time span after which groups with missing data are dropped from the monitor state. The minimum value is one hour, and the maximum value is 72 hours. Example values are: \"60m\", \"1h\", and \"2d\". This option is only available for APM Trace Analytics, Audit Trail, CI, Error Tracking, Event, Logs, and RUM monitors."
},
"groupby_simple_monitor": {
"type": "boolean",
"description": "Whether the log alert monitor triggers a single alert or multiple alerts when any group breaches a threshold. Use `notify_by` instead."
},
"include_tags": {
"type": "boolean",
"description": "A Boolean indicating whether notifications from this monitor automatically inserts its triggering tags into the title. **Examples** - If `True`, `[Triggered on {host:h1}] Monitor Title` - If `False`, `[Triggered] Monitor Title`"
},
"locked": {
"type": "boolean",
"description": "Whether or not the monitor is locked (only editable by creator and admins). Use `restricted_roles` instead."
},
"min_failure_duration": {
"type": "integer",
"description": "How long the test should be in failure before alerting (integer, number of seconds, max 7200)."
},
"min_location_failed": {
"type": "integer",
"description": "The minimum number of locations in failure at the same time during at least one moment in the `min_failure_duration` period (`min_location_failed` and `min_failure_duration` are part of the advanced alerting rules - integer, >= 1)."
},
"new_group_delay": {
"type": "integer",
"description": "Time (in seconds) to skip evaluations for new groups. For example, this option can be used to skip evaluations for new hosts while they initialize. Must be a non negative integer."
},
"new_host_delay": {
"type": "integer",
"description": "Time (in seconds) to allow a host to boot and applications to fully start before starting the evaluation of monitor results. Should be a non negative integer. Use new_group_delay instead."
},
"no_data_timeframe": {
"type": "integer",
"description": "The number of minutes before a monitor notifies after data stops reporting. Datadog recommends at least 2x the monitor timeframe for query alerts or 2 minutes for service checks. If omitted, 2x the evaluation timeframe is used for query alerts, and 24 hours is used for service checks."
},
"notification_preset_name": {
"type": "string",
"description": "Toggles the display of additional content sent in the monitor notification.",
"enum": [
"show_all",
"hide_query",
"hide_handles",
"hide_all",
"hide_query_and_handles",
"show_only_snapshot",
"hide_handles_and_footer"
]
},
"notify_audit": {
"type": "boolean",
"description": "A Boolean indicating whether tagged users is notified on changes to this monitor."
},
"notify_by": {
"type": "array",
"items": {
"type": "string"
},
"description": "Controls what granularity a monitor alerts on. Only available for monitors with groupings. For instance, a monitor grouped by `cluster`, `namespace`, and `pod` can be configured to only notify on each new `cluster` violating the alert conditions by setting `notify_by` to `[\"cluster\"]`. Tags mentioned in `notify_by` must be a subset of the grouping tags in the query. For example, a query grouped by `cluster` and `namespace` cannot notify on `region`. Setting `notify_by` to `[\"*\"]` configures the monitor to notify as a simple-alert."
},
"notify_no_data": {
"type": "boolean",
"description": "A Boolean indicating whether this monitor notifies when data stops reporting. Defaults to `false`."
},
"on_missing_data": {
"type": "string",
"description": "Controls how groups or monitors are treated if an evaluation does not return any data points. The default option results in different behavior depending on the monitor query type. For monitors using Count queries, an empty monitor evaluation is treated as 0 and is compared to the threshold conditions. For monitors using any query type other than Count, for example Gauge, Measure, or Rate, the monitor shows the last known status. This option is only available for APM Trace Analytics, Audit Trail, CI, Error Tracking, Event, Logs, and RUM monitors.",
"enum": [
"default",
"show_no_data",
"show_and_notify_no_data",
"resolve"
]
},
"renotify_interval": {
"type": "integer",
"description": "The number of minutes after the last notification before a monitor re-notifies on the current status. It only re-notifies if it’s not resolved."
},
"renotify_occurrences": {
"type": "integer",
"description": "The number of times re-notification messages should be sent on the current status at the provided re-notification interval."
},
"renotify_statuses": {
"type": "array",
"items": {
"type": "string",
"enum": [
"alert",
"warn",
"no data"
]
},
"description": "The types of monitor statuses for which re-notification messages are sent. Default: **null** if `renotify_interval` is **null**. If `renotify_interval` is set, defaults to renotify on `Alert` and `No Data`."
},
"require_full_window": {
"type": "boolean",
"description": "A Boolean indicating whether this monitor needs a full window of data before it’s evaluated. We highly recommend you set this to `false` for sparse metrics, otherwise some evaluations are skipped. Default is false. This setting only applies to metric monitors."
},
"scheduling_options": {
"type": "object",
"description": "Configuration options for scheduling."
},
"silenced": {
"type": "object",
"description": "Information about the downtime applied to the monitor. Only shows v1 downtimes."
},
"synthetics_check_id": {
"type": "string",
"description": "ID of the corresponding Synthetic check."
},
"threshold_windows": {
"type": "object",
"description": "Alerting time window options."
},
"thresholds": {
"type": "object",
"description": "List of the different monitor threshold available."
},
"timeout_h": {
"type": "integer",
"description": "The number of hours of the monitor not reporting data before it automatically resolves from a triggered state. The minimum allowed value is 0 hours. The maximum allowed value is 24 hours."
},
"variables": {
"type": "array",
"description": "List of requests that can be used in the monitor query. **This feature is currently in beta.**"
}
}
},
"overall_state": {
"type": "string",
"description": "The different states your monitor can be in.",
"enum": [
"Alert",
"Ignored",
"No Data",
"OK",
"Skipped",
"Unknown",
"Warn"
]
},
"priority": {
"type": [
"integer",
"null"
],
"description": "Integer from 1 (high) to 5 (low) indicating alert severity."
},
"query": {
"type": "string",
"description": "The monitor query."
},
"restricted_roles": {
"type": "array",
"items": {
"type": "string"
},
"description": "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](https://docs.datadoghq.com/api/latest/roles/#list-roles) 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](https://docs.datadoghq.com/api/latest/restriction-policies/) to manage write authorization for individual monitors by teams and users, in addition to roles."
},
"state": {
"type": "object",
"description": "Wrapper object with the different monitor states.",
"properties": {
"groups": {
"type": "object",
"description": "Dictionary where the keys are groups (comma separated lists of tags) and the values are the list of groups your monitor is broken down on."
}
}
},
"tags": {
"type": "array",
"items": {
"type": "string"
},
"description": "Tags associated to your monitor."
},
"type": {
"type": "string",
"description": "The type of the monitor. For more information about `type`, see the [monitor options](https://docs.datadoghq.com/monitors/guide/monitor_api_options/) docs.",
"enum": [
"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"
]
}
},
"required": [
"PCID",
"query",
"type"
]
}
```