v1

latestOpenAPI 3.0.02026-07-142351,1971.3 MB

Downtimes

Schedule a downtime

Schedule a downtime. Note: This endpoint has been deprecated. Please use v2 endpoints.

post/api/v1/downtime

Request body

activeboolean

If a scheduled downtime currently exists.

canceledinteger nullable

If a scheduled downtime is canceled.

creator_idinteger

User ID of the downtime creator.

disabledboolean

If a downtime has been disabled.

downtime_typeinteger

0 for a downtime applied on * or all, 1 when the downtime is only scoped to hosts, or 2 when the downtime is scoped to anything but hosts.

endinteger nullable

POSIX timestamp to end the downtime. If not provided, the downtime is in effect indefinitely until you cancel it.

idinteger

The downtime ID.

messagestring nullable

A message to include with notifications for this downtime. Email notifications can be sent to specific users by using the same @username notation as events.

monitor_idinteger nullable

A single monitor to which the downtime applies. If not provided, the downtime applies to all monitors.

monitor_tagsstring[]

A comma-separated list of monitor tags. For example, tags that are applied directly to monitors, not tags that are used in monitor queries (which are filtered by the scope parameter), to which the downtime applies. The resulting downtime applies to monitors that match ALL provided monitor tags. For example, service:postgres AND team:frontend.

mute_first_recovery_notificationboolean

If the first recovery notification during a downtime should be muted.

notify_end_statesNotifyEndState[]

States for which notify_end_types sends out notifications for.

notify_end_typesNotifyEndType[]

If set, notifies if a monitor is in an alert-worthy state (ALERT, WARNING, or NO DATA) when this downtime expires or is canceled. Applied to monitors that change states during the downtime (such as from OK to ALERT, WARNING, or NO DATA), and to monitors that already have an alert-worthy state when downtime begins.

parent_idinteger nullable

ID of the parent Downtime.

scopestring[]

The scope(s) to which the downtime applies and 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).

startinteger

POSIX timestamp to start the downtime. If not provided, the downtime starts the moment it is created.

timezonestring

The timezone in which to display the downtime's start and end times in Datadog applications.

updater_idinteger nullable

ID of the last user that updated the downtime.

Example request

{
  "active": true,
  "active_child": {
    "active": true,
    "canceled": 1412799983,
    "creator_id": 123456,
    "downtime_type": 2,
    "end": 1412793983,
    "id": 1626,
    "message": "Message on the downtime",
    "monitor_id": 123456,
    "monitor_tags": [
      "*"
    ],
    "notify_end_states": [
      "alert",
      "no data",
      "warn"
    ],
    "notify_end_types": [
      "canceled",
      "expired"
    ],
    "parent_id": 123,
    "recurrence": {
      "period": 1,
      "rrule": "FREQ=MONTHLY;BYSETPOS=3;BYDAY=WE;INTERVAL=1",
      "type": "weeks",
      "until_date": 1447786293,
      "until_occurrences": 2,
      "week_days": [
        "Mon",
        "Tue"
      ]
    },
    "scope": [
      "env:staging"
    ],
    "start": 1412792983,
    "timezone": "America/New_York",
    "updater_id": 123456
  },
  "canceled": 1412799983,
  "creator_id": 123456,
  "downtime_type": 2,
  "end": 1412793983,
  "id": 1625,
  "message": "Message on the downtime",
  "monitor_id": 123456,
  "monitor_tags": [
    "*"
  ],
  "notify_end_states": [
    "alert",
    "no data",
    "warn"
  ],
  "notify_end_types": [
    "canceled",
    "expired"
  ],
  "parent_id": 123,
  "recurrence": {
    "period": 1,
    "rrule": "FREQ=MONTHLY;BYSETPOS=3;BYDAY=WE;INTERVAL=1",
    "type": "weeks",
    "until_date": 1447786293,
    "until_occurrences": 2,
    "week_days": [
      "Mon",
      "Tue"
    ]
  },
  "scope": [
    "env:staging"
  ],
  "start": 1412792983,
  "timezone": "America/New_York",
  "updater_id": 123456
}

Response