Skip to content

outage.handler

Outage handlers

Create

Path
POST /v7.0/outages/{outage_id}/handlers
Description
Add a new outage handler
Authentication required
yes
Scope
outage.handler#create
Aliases
new
Blocking
no

Input parameters

Layout
object
Namespace
handler
ParameterTypeRequiredDetails
user
User
 Resource no
full_name
Full name
 String no

First and last name

Default: null
note
Note
 String no

Default: null

Output parameters

Layout
object
Namespace
handler
ParameterTypeDescription
id
Id
 Integer
user
User
 Resource
full_name
Full name
 String First and last name
note
Note
 String

Delete

Path
DELETE /v7.0/outages/{outage_id}/handlers/{handler_id}
Description
Remove an outage handler
Authentication required
yes
Scope
outage.handler#delete
Aliases
destroy
Blocking
no

Input parameters

No parameters.

Output parameters

No parameters.

Index

Path
GET /v7.0/outages/{outage_id}/handlers
Description
List outage entities
Authentication required
no
Scope
outage.handler#index
Aliases
list
Blocking
no

Input parameters

Layout
object
Namespace
handler
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

Output parameters

Layout
object_list
Namespace
handlers
ParameterTypeDescription
id
Id
 Integer
user
User
 Resource
full_name
Full name
 String First and last name
note
Note
 String

Show

Path
GET /v7.0/outages/{outage_id}/handlers/{handler_id}
Description
Show an outage handler
Authentication required
no
Scope
outage.handler#show
Aliases
find
Blocking
no

Input parameters

No parameters.

Output parameters

Layout
object
Namespace
handler
ParameterTypeDescription
id
Id
 Integer
user
User
 Resource
full_name
Full name
 String First and last name
note
Note
 String

Update

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

Input parameters

Layout
object
Namespace
handler
ParameterTypeRequiredDetails
note
Note
 String yes

Default: null

Validation rules
RuleDetails
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

Output parameters

Layout
object
Namespace
handler
ParameterTypeDescription
id
Id
 Integer
user
User
 Resource
full_name
Full name
 String First and last name
note
Note
 String