Datadog Downtime

Schedule Downtime

Schedule a downtime.

Inputs

Field

Type

Description

scope [required]

[string]

The scope(s) to which the downtime applies.

duration_seconds

number

How long to schedule the downtime for. Select length of time from drop down or input custom length of time in seconds. If not provided, the downtime is in effect indefinitely until you cancel it.

message

string

A message to include with notifications for this downtime.

monitor_id

number,string

A single monitor to which the downtime applies.

monitor_tags

A comma-separated list of monitor tags.

mute_first_recovery_notification

boolean

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

Outputs

Expand All

Field

Type

Description

active

boolean

If a scheduled downtime currently exists.

active_child

object

The downtime object definition of the active child for the original parent recurring downtime.

active

boolean

If a scheduled downtime currently exists.

canceled

number

If a scheduled downtime is canceled.

creator_id

number

User ID of the downtime creator.

disabled

boolean

If a downtime has been disabled.

downtime_type

number

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.

end

number

POSIX timestamp to end the downtime.

id

number,string

The downtime ID.

message

string

A message to include with notifications for this downtime.

monitor_id

number,string

A single monitor to which the downtime applies.

monitor_tags

[string]

A comma-separated list of monitor tags.

parent_id

number,string

ID of the parent Downtime.

recurrence

object

An object defining the recurrence of the downtime.

period

number

How often to repeat as an integer.

type

string

The type of recurrence.

rrule

string

The RRULE standard for defining recurring events (requires to set "type" to rrule) For example, to have a recurring event on the first day of each month, set the type to rrule and set the FREQ to MONTHLY and BYMONTHDAY to 1.

until_date

number

The date at which the recurrence should end as a POSIX timestamp.

until_occurrences

number

How many times the downtime is rescheduled.

week_days

[string]

A list of week days to repeat on.

scope

[string]

The scope(s) to which the downtime applies.

start

number

POSIX timestamp to start the downtime.

timezone

string

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

updater_id

number

ID of the last user that updated the downtime.

canceled

number

If a scheduled downtime is canceled.

creator_id

number

User ID of the downtime creator.

disabled

boolean

If a downtime has been disabled.

downtime_type

number

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.

end

number

POSIX timestamp to end the downtime.

id

number,string

The downtime ID.

message

string

A message to include with notifications for this downtime.

monitor_id

number,string

A single monitor to which the downtime applies.

monitor_tags

[string]

A comma-separated list of monitor tags.

mute_first_recovery_notification

boolean

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

parent_id

number,string

ID of the parent Downtime.

recurrence

object

An object defining the recurrence of the downtime.

period

number

How often to repeat as an integer.

type

string

The type of recurrence.

rrule

string

The RRULE standard for defining recurring events (requires to set "type" to rrule) For example, to have a recurring event on the first day of each month, set the type to rrule and set the FREQ to MONTHLY and BYMONTHDAY to 1.

until_date

number

The date at which the recurrence should end as a POSIX timestamp.

until_occurrences

number

How many times the downtime is rescheduled.

week_days

[string]

A list of week days to repeat on.

scope

[string]

The scope(s) to which the downtime applies.

start

number

POSIX timestamp to start the downtime.

timezone

string

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

updater_id

number

ID of the last user that updated the downtime.