Skip to content

monitored_event

Browser monitored events

Acknowledge

Path
POST /v7.0/monitored_events/{monitored_event_id}/acknowledge
Description
Authentication required
yes
Scope
monitored_event#acknowledge
Aliases
ack
Blocking
no

Input parameters

Layout
object
Namespace
monitored_event
ParameterTypeRequiredDetails
until
Until
 Datetime no

Default: null

Output parameters

No parameters.

Ignore

Path
POST /v7.0/monitored_events/{monitored_event_id}/ignore
Description
Authentication required
yes
Scope
monitored_event#ignore
Aliases
Blocking
no

Input parameters

Layout
object
Namespace
monitored_event
ParameterTypeRequiredDetails
until
Until
 Datetime no

Default: null

Output parameters

No parameters.

Index

Path
GET /v7.0/monitored_events
Description
Authentication required
yes
Scope
monitored_event#index
Aliases
list
Blocking
no

Input parameters

Layout
object
Namespace
monitored_event
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: 25

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
monitor
Monitor
 String no

Default: null
object_name
Object_name
 String no

Default: null
object_id
Object_id
 Integer no

Default: null
state
State
 String no

Default: null

Validation rules
RuleDetails
Include

Allowed values:

  • monitoring
  • confirmed
  • unconfirmed
  • acknowledged
  • ignored
  • closed

Validation error message: %{value} cannot be used
user
User
 Resource no
order
Order
 String no

Template order

Default: latest

Validation rules
RuleDetails
Include

Allowed values:

  • oldest
  • latest
  • longest
  • shortest

Validation error message: %{value} cannot be used
from_duration
From_duration
 Float no

Paginate by duration

Default: null

Output parameters

Layout
object_list
Namespace
monitored_events
ParameterTypeDescription
id
Id
 Integer
monitor
Monitor
 String
label
Label
 String
issue
Issue
 String
object_name
Object_name
 String
object_id
Object_id
 Integer
state
State
 String
user
User
 Resource
created_at
Created_at
 Datetime
updated_at
Updated_at
 Datetime
duration
Duration
 Float Outage duration in minutes
saved_until
Saved_until
 Datetime

Show

Path
GET /v7.0/monitored_events/{monitored_event_id}
Description
Authentication required
yes
Scope
monitored_event#show
Aliases
find
Blocking
no

Input parameters

No parameters.

Output parameters

Layout
object
Namespace
monitored_event
ParameterTypeDescription
id
Id
 Integer
monitor
Monitor
 String
label
Label
 String
issue
Issue
 String
object_name
Object_name
 String
object_id
Object_id
 Integer
state
State
 String
user
User
 Resource
created_at
Created_at
 Datetime
updated_at
Updated_at
 Datetime
duration
Duration
 Float Outage duration in minutes
saved_until
Saved_until
 Datetime

Subresources