Skip to content

outage_update

Browse outage updates

Create

Path
POST /v7.0/outage_updates
Description
Create outage update
Authentication required
yes
Scope
outage_update#create
Aliases
new
Blocking
yes

Input parameters

Layout
object
Namespace
outage_update
ParameterTypeRequiredDetails
outage
Outage
 Resource no

Outage linked to a security advisory.
begins_at
Begins at
 Datetime no

Default: null
finished_at
Finished at
 Datetime no

Default: null
duration
Duration
 Integer no

Outage duration in minutes

Default: null
state
State
 String no

Default: null

Validation rules
RuleDetails
Include

Allowed values:

  • staged
  • announced
  • resolved
  • cancelled

Validation error message: %{value} cannot be used
impact
Impact
 String no

Default: null

Validation rules
RuleDetails
Include

Allowed values:

  • tbd
  • system_restart
  • system_reset
  • network
  • performance
  • unavailability
  • export

Validation error message: %{value} cannot be used
en_summary
English summary
 String no

Default: null
en_description
English description
 String no

User-facing explanation of the vulnerability, affected systems, impact, and conditions.

Default: null
cs_summary
Česky summary
 String no

Default: null
cs_description
Česky description
 String no

User-facing explanation of the vulnerability, affected systems, impact, and conditions.

Default: null
send_mail
Send mail
 Boolean no

Default: true

Output parameters

Layout
object
Namespace
outage_update
ParameterTypeDescription
id
Id
 Integer
outage
Outage
 Resource Outage linked to a security advisory.
type
Type
 String node, storage or mailer
begins_at
Begins at
 Datetime
finished_at
Finished at
 Datetime
duration
Duration
 Integer Outage duration in minutes
state
State
 String
impact
Impact
 String
en_summary
English summary
 String
en_description
English description
 String User-facing explanation of the vulnerability, affected systems, impact, and conditions.
cs_summary
Česky summary
 String
cs_description
Česky description
 String User-facing explanation of the vulnerability, affected systems, impact, and conditions.
reported_by
Reported by
 Resource
reporter_name
Reporter's name
 String
created_at
Reported at
 Datetime

Index

Path
GET /v7.0/outage_updates
Description
List outage updates
Authentication required
no
Scope
outage_update#index
Aliases
list
Blocking
no

Input parameters

Layout
object
Namespace
outage_update
ParameterTypeRequiredDetails
from_id
From ID
 Integer no

List objects with IDs greater or lower than this value

Default: null

Validation rules
RuleDetails
Number
  • Must be a number after parameter type conversion.
  • Minimum: 0 (inclusive).

Validation error message: must be at least 0
limit
Limit
 Integer no

Number of objects to retrieve

Default: null

Validation rules
RuleDetails
Number
  • Must be a number after parameter type conversion.
  • Minimum: 0 (inclusive).
  • Maximum: 1000 (inclusive).

Validation error message: must be between 0 and 1000
outage
Outage
 Resource no

Outage linked to a security advisory.
reported_by
Reported by
 Resource no
since
Since
 Datetime no

Filter updates reported since specified date

Default: null

Output parameters

Layout
object_list
Namespace
outage_updates
ParameterTypeDescription
id
Id
 Integer
outage
Outage
 Resource Outage linked to a security advisory.
type
Type
 String node, storage or mailer
begins_at
Begins at
 Datetime
finished_at
Finished at
 Datetime
duration
Duration
 Integer Outage duration in minutes
state
State
 String
impact
Impact
 String
en_summary
English summary
 String
en_description
English description
 String User-facing explanation of the vulnerability, affected systems, impact, and conditions.
cs_summary
Česky summary
 String
cs_description
Česky description
 String User-facing explanation of the vulnerability, affected systems, impact, and conditions.
reported_by
Reported by
 Resource
reporter_name
Reporter's name
 String
created_at
Reported at
 Datetime

Show

Path
GET /v7.0/outage_updates/{outage_update_id}
Description
Show outage update
Authentication required
no
Scope
outage_update#show
Aliases
find
Blocking
no

Input parameters

No parameters.

Output parameters

Layout
object
Namespace
outage_update
ParameterTypeDescription
id
Id
 Integer
outage
Outage
 Resource Outage linked to a security advisory.
type
Type
 String node, storage or mailer
begins_at
Begins at
 Datetime
finished_at
Finished at
 Datetime
duration
Duration
 Integer Outage duration in minutes
state
State
 String
impact
Impact
 String
en_summary
English summary
 String
en_description
English description
 String User-facing explanation of the vulnerability, affected systems, impact, and conditions.
cs_summary
Česky summary
 String
cs_description
Česky description
 String User-facing explanation of the vulnerability, affected systems, impact, and conditions.
reported_by
Reported by
 Resource
reporter_name
Reporter's name
 String
created_at
Reported at
 Datetime