Skip to content

user_outage

Browse users affected by outages

Index

Path
GET /v7.0/user_outages
Description
List users affected by outage
Authentication required
yes
Scope
user_outage#index
Aliases
list
Blocking
no

Input parameters

Layout
object
Namespace
user_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.
user
User
 Resource no

Output parameters

Layout
object_list
Namespace
user_outages
ParameterTypeDescription
id
Id
 Integer
outage
Outage
 Resource Outage linked to a security advisory.
user
User
 Resource
vps_count
Vps_count
 Integer
export_count
Export_count
 Integer

Show

Path
GET /v7.0/user_outages/{user_outage_id}
Description
Show user affected by an outage
Authentication required
yes
Scope
user_outage#show
Aliases
find
Blocking
no

Input parameters

No parameters.

Output parameters

Layout
object
Namespace
user_outage
ParameterTypeDescription
id
Id
 Integer
outage
Outage
 Resource Outage linked to a security advisory.
user
User
 Resource
vps_count
Vps_count
 Integer
export_count
Export_count
 Integer