outage

Report and browse outages

Create

Path: POST /v7.0/outages
Description: Stage a new outage
Authentication required: yes
Scope: outage#create
Aliases: new
Blocking: no

Input parameters

Layout: object
Namespace: outage

Parameter Type Required Details

begins_at

Begins at

Datetime

yes

Default: null

Validation rules
Rule	Details
Present	Must be supplied and cannot be null. Must not be empty; strings must contain a non-whitespace character. Validation error message: must be present and non-empty

finished_at

Finished at

Datetime

Default: null

duration

Duration

Integer

yes

Outage duration in minutes

Default: null

Validation rules
Rule	Details
Present	Must be supplied and cannot be null. Must not be empty; strings must contain a non-whitespace character. Validation error message: must be present and non-empty

type

Type

String

yes

node, storage or mailer

Default: null

Validation rules
Rule	Details
Include	Allowed values: `planned_outage` `unplanned_outage` Validation error message: %{value} cannot be used
Present	Must be supplied and cannot be null. Must not be empty; strings must contain a non-whitespace character. Validation error message: must be present and non-empty

impact

Impact

String

yes

Default: null

Validation rules
Rule	Details
Include	Allowed values: `tbd` `system_restart` `system_reset` `network` `performance` `unavailability` `export` Validation error message: %{value} cannot be used
Present	Must be supplied and cannot be null. Must not be empty; strings must contain a non-whitespace character. Validation error message: must be present and non-empty

auto_resolve

Auto-resolve

Boolean

Default: true

en_summary

English summary

String

yes

Default: null

Validation rules
Rule	Details
Present	Must be supplied and cannot be null. Must not be empty; strings must contain a non-whitespace character. Validation error message: must be present and non-empty

en_description

English description

String

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

Default: null

cs_summary

Česky summary

String

yes

Default: null

Validation rules
Rule	Details
Present	Must be supplied and cannot be null. Must not be empty; strings must contain a non-whitespace character. Validation error message: must be present and non-empty

cs_description

Česky description

String

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

Default: null

Output parameters

Layout: object
Namespace: outage

Parameter	Type	Description
`id` Id	Integer
`begins_at` Begins at	Datetime
`finished_at` Finished at	Datetime
`duration` Duration	Integer	Outage duration in minutes
`type` Type	String	node, storage or mailer
`state` State	String
`impact` Impact	String
`auto_resolve` Auto-resolve	Boolean
`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.
`affected` Affected	Boolean	True if the current user is affected by the outage
`affected_user_count` Affected users	Integer	Number of affected users
`affected_direct_vps_count` Directly affected VPSes	Integer	Number of directly affected VPSes
`affected_indirect_vps_count` Indirectly affected VPSes	Integer	Number of indirectly affected VPSes
`affected_export_count` Affected exports	Integer	Number of affected exoirts

Index

Path: GET /v7.0/outages
Description: List outages
Authentication required: no
Scope: outage#index
Aliases: list
Blocking: no

Input parameters

Layout: object
Namespace: outage

Parameter Type Required Details

from_id

From ID

Integer

List objects with IDs greater or lower than this value

Default: null

Validation rules
Rule	Details
Number	Must be a number after parameter type conversion. Minimum: `0` (inclusive). Validation error message: must be at least 0

limit

Limit

Integer

Number of objects to retrieve

Default: null

Validation rules
Rule	Details
Number	Must be a number after parameter type conversion. Minimum: `0` (inclusive). Maximum: `1000` (inclusive). Validation error message: must be between 0 and 1000

type

Type

String

node, storage or mailer

Default: null

Validation rules
Rule	Details
Include	Allowed values: `planned_outage` `unplanned_outage` Validation error message: %{value} cannot be used

state

State

String

Default: null

Validation rules
Rule	Details
Include	Allowed values: `staged` `announced` `resolved` `cancelled` Validation error message: %{value} cannot be used

impact

Impact

String

Default: null

Validation rules
Rule	Details
Include	Allowed values: `tbd` `system_restart` `system_reset` `network` `performance` `unavailability` `export` Validation error message: %{value} cannot be used

affected

Affected

Boolean

True if the current user is affected by the outage

Default: null

recent_since

Recent_since

Datetime

Filter announced or recently reported outages

Default: null

user

User

Resource

Filter outages affecting a specific user

vps

VPS

Resource

Filter outages affecting a specific VPS

export

Export

Resource

Filter outages affecting a specific export

handled_by

Handled by

Resource

Filter outages handled by user

environment

Environment

Resource

Filter outages by environment

location

Location

Resource

Filter outages by location

node

Node

Resource

Filter outages by node

component

Component

Resource

Filter outages by vpsAdmin component

security_advisory

Security advisory

Resource

Filter outages linked to a security advisory

entity_name

Entity name

String

Filter outages by entity name

Default: null

entity_id

Entity ID

Integer

Filter outages by entity ID

Default: null

order

Order

String

Template order

Default: newest

Validation rules
Rule	Details
Include	Allowed values: `newest` `oldest` Validation error message: %{value} cannot be used

since

Since

Datetime

Filter outages reported since specified date

Default: null

Output parameters

Layout: object_list
Namespace: outages

Parameter	Type	Description
`id` Id	Integer
`begins_at` Begins at	Datetime
`finished_at` Finished at	Datetime
`duration` Duration	Integer	Outage duration in minutes
`type` Type	String	node, storage or mailer
`state` State	String
`impact` Impact	String
`auto_resolve` Auto-resolve	Boolean
`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.
`affected` Affected	Boolean	True if the current user is affected by the outage
`affected_user_count` Affected users	Integer	Number of affected users
`affected_direct_vps_count` Directly affected VPSes	Integer	Number of directly affected VPSes
`affected_indirect_vps_count` Indirectly affected VPSes	Integer	Number of indirectly affected VPSes
`affected_export_count` Affected exports	Integer	Number of affected exoirts

Rebuild_affected_vps

Path: POST /v7.0/outages/{outage_id}/rebuild_affected_vps
Description: Rebuilt the list of affected vpses, use after changing affected entities
Authentication required: yes
Scope: outage#rebuild_affected_vps
Aliases
Blocking: no

Input parameters

No parameters.

Output parameters

No parameters.

Show

Path: GET /v7.0/outages/{outage_id}
Description: Show outage details
Authentication required: no
Scope: outage#show
Aliases: find
Blocking: no

Input parameters

No parameters.

Output parameters

Layout: object
Namespace: outage

Parameter	Type	Description
`id` Id	Integer
`begins_at` Begins at	Datetime
`finished_at` Finished at	Datetime
`duration` Duration	Integer	Outage duration in minutes
`type` Type	String	node, storage or mailer
`state` State	String
`impact` Impact	String
`auto_resolve` Auto-resolve	Boolean
`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.
`affected` Affected	Boolean	True if the current user is affected by the outage
`affected_user_count` Affected users	Integer	Number of affected users
`affected_direct_vps_count` Directly affected VPSes	Integer	Number of directly affected VPSes
`affected_indirect_vps_count` Indirectly affected VPSes	Integer	Number of indirectly affected VPSes
`affected_export_count` Affected exports	Integer	Number of affected exoirts

Update

Path: PUT /v7.0/outages/{outage_id}
Description: Update an outage
Authentication required: yes
Scope: outage#update
Aliases
Blocking: no

Input parameters

Layout: object
Namespace: outage

Parameter Type Required Details

begins_at

Begins at

Datetime

Default: null

finished_at

Finished at

Datetime

Default: null

duration

Duration

Integer

Outage duration in minutes

Default: null

type

Type

String

node, storage or mailer

Default: null

Validation rules
Rule	Details
Include	Allowed values: `planned_outage` `unplanned_outage` Validation error message: %{value} cannot be used

impact

Impact

String

Default: null

Validation rules
Rule	Details
Include	Allowed values: `tbd` `system_restart` `system_reset` `network` `performance` `unavailability` `export` Validation error message: %{value} cannot be used

auto_resolve

Auto-resolve

Boolean

Default: true

en_summary

English summary

String

Default: null

en_description

English description

String

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

Default: null

cs_summary

Česky summary

String

Default: null

cs_description

Česky description

String

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

Default: null

Output parameters

Layout: object
Namespace: outage

Parameter	Type	Description
`id` Id	Integer
`begins_at` Begins at	Datetime
`finished_at` Finished at	Datetime
`duration` Duration	Integer	Outage duration in minutes
`type` Type	String	node, storage or mailer
`state` State	String
`impact` Impact	String
`auto_resolve` Auto-resolve	Boolean
`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.
`affected` Affected	Boolean	True if the current user is affected by the outage
`affected_user_count` Affected users	Integer	Number of affected users
`affected_direct_vps_count` Directly affected VPSes	Integer	Number of directly affected VPSes
`affected_indirect_vps_count` Indirectly affected VPSes	Integer	Number of indirectly affected VPSes
`affected_export_count` Affected exports	Integer	Number of affected exoirts

outage#

Create#

Input parameters#

Output parameters#

Index#

Input parameters#

Output parameters#

Rebuild_affected_vps#

Input parameters#

Output parameters#

Show#

Input parameters#

Output parameters#

Update#

Input parameters#

Output parameters#

Subresources#

outage

Create

Input parameters

Output parameters

Index

Input parameters

Output parameters

Rebuild_affected_vps

Input parameters

Output parameters

Show

Input parameters

Output parameters

Update

Input parameters

Output parameters

Subresources