HomeRelease Notes
API Reference
API Reference

Update Incident

put
https://{domain}/api/v4/incident
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params

The input.

string
enum

Incident Type

Members:

  • ScheduledMaintenance - Scheduled Maintenance
  • ServiceUnavailable - Incident
  • Informational - Informational

Allowed:
string | null

The title of the incident

boolean | null

Whether or not the incident is published (visible to all)

string | null

An external identifier for the incident

string
enum

Role

Members:

  • Anonymous - Everyone
  • Subscriber - Subscriber
  • Employee - Employee
  • Manager - Manager
  • Administrator - Administrator

Allowed:
scheduledMaintenance
object

ScheduledMaintenance

notificationChannels
array of objects | null

The notification channels to notify others about the incident

notificationChannels
posts
array of objects | null

A List of incident updates

posts
affectedComponents
array of int32s | null

A List of affected components

affectedComponents
affectedGroups
array of int32s | null

A List of affected groups

affectedGroups
boolean | null

This incident will cause downtime

customFields
array of objects | null

A List of custom fields

customFields
string | null

Auto-closing message for scheduled maintenances

autocloseChannels
array of objects | null

Auto-closing notification channels for scheduled maintenances

autocloseChannels
notifyBeforeChannels
array of objects | null

Notification channels of scheduled maintenances for notifying before

notifyBeforeChannels
boolean

Send or resend notifications. Only used if IsPublished is true

boolean | null

Auto assign groups by components

int32

The id of the incident

Responses

401

Unauthorized

403

Forbidden

405

NotAllowed

Updated about 1 year ago

Language
Credentials
Bearer
JWT
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated about 1 year ago