このページは日本語には対応しておりません。随時翻訳に取り組んでいます。翻訳に関してご質問やご意見ございましたら、お気軽にご連絡ください。

Search all scheduled downtimes matching the provided filters. The search is limited to 1000 downtimes.

Inputs

フィールド

種類

説明

scopes

[string]

A list of scope values the downtimes should have. Logical operator like OR or AND are not supported in the values. Instead of service:(a OR b), add two values service:a and service:b.

You can also use - to exclude a scope value. For example, -env:staging will return downtimes without the scope env:staging.

monitor_tags

A list of monitor tags that the filtered downtimes should have. You can also use - to exclude monitor tags. For example, -env:staging will return downtimes without the monitor tag env:staging.

current_only

boolean

Only return downtimes that are active when the request is made.

recurring

boolean

Filter downtimes that are recurring.

automuted

boolean

Filter downtimes that are automuted.

page_limit

number

Maximum number of downtimes in the response.

default: 100

Outputs

Expand All

フィールド

種類

説明

downtimes [required]

[object]

The list of downtimes that match the search criteria.

url [required]

string

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.

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.