datadog update-downtime
Update a downtime
Description
Update a downtime
Synopsis
datadog update-downtime
[--site <site>]
<downtime>
[--disabled]
[--end <end>]
[--message <message>]
[--id <id>]
[--tags <tags>]
[--mute_first_recovery_notification]
[--parent <parent>]
[--period <period>]
[--rrule <rrule>]
[--type <type>]
[--until <until>]
[--occurrences <occurrences>]
[--days <days>]
[--scope <scope>]
[--start <start>]
[--timezone <timezone>]
Arguments
site
- (string)
Site where this command will be executed
Example: --site "site-1"
Default: input.site
Attributes: optional
downtime
- (int)
ID of the Downtime
Example: 1
Default: _None_
Attributes: required
disabled
- (bool)
If a downtime has been disabled
Example: --disabled
Default: false
Attributes: optional
end
- (time)
time to end the downtime. If not provided, the downtime is in effect indefinitely until you cancel it
Example: --end "2019-10-12T07:20:50.52Z"
Default: _None_
Attributes: optional
message
- (string)
A message to include with notifications for this downtime
Example: --message "message-1"
Default: _None_
Attributes: optional
id
- (int)
A single monitor to which the downtime applies. If not provided, the downtime applies to all monitors
Example: --id 1
Default: _None_
Attributes: optional
tags
- (string)
Monitor tags. The resulting downtime applies to monitors that match ALL provided monitor tags. For example, service:postgres AND team:frontend
Example: --tags "tags-1"
Default: _None_
Attributes: optional, multiple allowed
mute_first_recovery_notification
- (bool)
If the first recovery notification during a downtime should be muted
Example: --mute_first_recovery_notification
Default: _None_
Attributes: optional
parent
- (int)
ID of the parent Downtime
Example: --parent 1
Default: _None_
Attributes: optional
period
- (int)
How often to repeat(days) as an integer
Example: --period 1
Default: _None_
Attributes: optional
rrule
- (string)
The RRULE standard for defining recurring events (requires to set "type" to rrule) Most common rrule options from the iCalendar Spec are supported
Example: --rrule "rrule-1"
Default: _None_
Attributes: optional
type
- (string)
The type of recurrence
Example: --type "type-1"
Default: _None_
Attributes: optional
Validation:
allowed values: days, weeks, months, years, rrule
until
- (int)
The date at which the recurrence should end as a POSIX timestamp. occurences and until are mutually exclusive
Example: --until 1
Default: _None_
Attributes: optional
occurrences
- (int)
How many times the downtime is rescheduled. occurences and until are mutually exclusive
Example: --occurrences 1
Default: _None_
Attributes: optional
days
- (string)
A list of week days to repeat on
Example: --days "days-1"
Default: _None_
Attributes: optional, multiple allowed
Validation:
allowed values: Mon, Tue, Wed, Thu, Fri, Sat, Sun
scope
- (string)
The scope(s) to which the downtime applies
Example: --scope "scope-1"
Default: _None_
Attributes: optional, multiple allowed
Validation:
allowed values: env:dev, env:prod
start
- (time)
time to start the downtime. If not provided, the downtime starts the moment it is created
Example: --start "2019-10-12T07:20:50.52Z"
Default: _None_
Attributes: optional
timezone
- (string)
The timezone in which to display the downtime's start and end times in Datadog applications
Example: --timezone "timezone-1"
Default: _None_
Attributes: optional
Examples
Input:
Output:ID MESSAGE TYPE MONITOR-ID ACTIVE PARENT CHILD RECURRENCE
4051708 EDITEDMESSAGE2 2 null false null 4058011 months
Access Control
To use this command, you need access to the following:
Field | Value |
---|---|
Action | "update" |
Service Type | "datadog" |
Service Instance | |
Namespace | |
Object Type | "downtime" |
Object ID |
Please see Access Control for details.