Skip to content

vps_outage

Browse VPSes affected by outages

Index

Path
GET /v7.0/vps_outages
Description
List VPSes affected by outage
Authentication required
yes
Scope
vps_outage#index
Aliases
list
Blocking
no

Input parameters

Layout
object
Namespace
vps_outage
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.
vps
VPS
 Resource no
user
User
 Resource no
environment
Environment
 Resource no
location
Location
 Resource no
node
Node
 Resource no
direct
Direct
 Boolean no

Default: null

Output parameters

Layout
object_list
Namespace
vps_outages
ParameterTypeDescription
id
Id
 Integer
outage
Outage
 Resource Outage linked to a security advisory.
vps
VPS
 Resource
user
User
 Resource
environment
Environment
 Resource
location
Location
 Resource
node
Node
 Resource
direct
Direct
 Boolean

Show

Path
GET /v7.0/vps_outages/{vps_outage_id}
Description
Show VPS affected by an outage
Authentication required
yes
Scope
vps_outage#show
Aliases
find
Blocking
no

Input parameters

No parameters.

Output parameters

Layout
object
Namespace
vps_outage
ParameterTypeDescription
id
Id
 Integer
outage
Outage
 Resource Outage linked to a security advisory.
vps
VPS
 Resource
user
User
 Resource
environment
Environment
 Resource
location
Location
 Resource
node
Node
 Resource
direct
Direct
 Boolean