Skip to content

incident_report

Manage incident reports

Create

Path
POST /v7.0/incident_reports
Description
Create incident report
Authentication required
yes
Scope
incident_report#create
Aliases
new
Blocking
yes

Input parameters

Layout
object
Namespace
incident_report
ParameterTypeRequiredDetails
vps
VPS
 Resource yes
ip_address_assignment
IP address assignment
 Resource no
subject
Subject
 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
text
Text
 Text 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
codename
Codename
 String no

Default: null
cpu_limit
CPU limit
 Integer no

Limit of maximum CPU usage

Default: null
vps_action
VPS action
 String no

Default: none

Validation rules
RuleDetails
Include

Allowed values:

  • none
  • stop
  • suspend
  • disable_network

Validation error message: %{value} cannot be used
detected_at
Detected_at
 Datetime no

Default: null

Output parameters

Layout
object
Namespace
incident_report
ParameterTypeDescription
id
ID
 Integer
user
User
 Resource
vps
VPS
 Resource
ip_address_assignment
IP address assignment
 Resource
filed_by
Filed_by
 Resource
mailbox
Mailbox
 Resource
subject
Subject
 String
text
Text
 Text
codename
Codename
 String
cpu_limit
CPU limit
 Integer Limit of maximum CPU usage
vps_action
VPS action
 String
raw_user_id
Raw_user_id
 Integer
raw_vps_id
Raw_vps_id
 Integer
detected_at
Detected_at
 Datetime
created_at
Created_at
 Datetime
reported_at
Reported_at
 Datetime

Index

Path
GET /v7.0/incident_reports
Description
List incident reports
Authentication required
yes
Scope
incident_report#index
Aliases
list
Blocking
no

Input parameters

Layout
object
Namespace
incident_report
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
user
User
 Resource no
vps
VPS
 Resource no
ip_address_assignment
IP address assignment
 Resource no
filed_by
Filed_by
 Resource no
mailbox
Mailbox
 Resource no
codename
Codename
 String no

Default: null
ip_addr
IP address
 String no

Default: null

Output parameters

Layout
object_list
Namespace
incident_reports
ParameterTypeDescription
id
ID
 Integer
user
User
 Resource
vps
VPS
 Resource
ip_address_assignment
IP address assignment
 Resource
filed_by
Filed_by
 Resource
mailbox
Mailbox
 Resource
subject
Subject
 String
text
Text
 Text
codename
Codename
 String
cpu_limit
CPU limit
 Integer Limit of maximum CPU usage
vps_action
VPS action
 String
raw_user_id
Raw_user_id
 Integer
raw_vps_id
Raw_vps_id
 Integer
detected_at
Detected_at
 Datetime
created_at
Created_at
 Datetime
reported_at
Reported_at
 Datetime

Show

Path
GET /v7.0/incident_reports/{incident_report_id}
Description
Show incident report
Authentication required
yes
Scope
incident_report#show
Aliases
find
Blocking
no

Input parameters

No parameters.

Output parameters

Layout
object
Namespace
incident_report
ParameterTypeDescription
id
ID
 Integer
user
User
 Resource
vps
VPS
 Resource
ip_address_assignment
IP address assignment
 Resource
filed_by
Filed_by
 Resource
mailbox
Mailbox
 Resource
subject
Subject
 String
text
Text
 Text
codename
Codename
 String
cpu_limit
CPU limit
 Integer Limit of maximum CPU usage
vps_action
VPS action
 String
raw_user_id
Raw_user_id
 Integer
raw_vps_id
Raw_vps_id
 Integer
detected_at
Detected_at
 Datetime
created_at
Created_at
 Datetime
reported_at
Reported_at
 Datetime