コンテンツにスキップ

手動インシデント作成

POST
/dashboard/services/{id}/incidents

サービスに手動インシデント (type: manual) を作成する。 作成されたインシデントは status: ongoing / monitorId: null になる。 作成後に通知キューへ incident.created を送信する。 キュー送信に失敗しても作成自体は成功扱い (201) で、notificationSent: falsewarnings で通知する。

id
required
string

サービス ID

object
title
required
string
>= 1 characters <= 200 characters
cause
string
<= 5000 characters

インシデント作成成功

object
incident
object
id
string
monitorId
string
nullable
teamId
string
type
string
Allowed values: auto manual change warning
status
string
Allowed values: ongoing resolved acknowledged
title
string
nullable
startedAt
string format: date-time
resolvedAt
string format: date-time
nullable
cause
string
nullable
serviceId

Service ID the incident is displayed on

string
createdAt
string format: date-time
notificationSent

通知キューへの送信に成功したか

boolean
warnings

作成は成功したが付随処理に失敗した場合の警告

Array<object>

主処理は成功したが付随処理 (通知送信など) に失敗したことを示す警告。 正本は apps/api/src/routes/incidents.ts の ApiWarning インターフェース。

object
code
string
Example
NOTIFICATION_SEND_FAILED
message
string
Example
Failed to send notification

バリデーションエラー

object
error
object
code
string
Example
VALIDATION_ERROR
message
string
Example
Invalid request body
status
integer
Example
400
upgradeUrl

URL to upgrade plan (only present for plan limit errors)

string
Example
https://app.manako.dev/billing

サービスが見つからない

object
error
object
code
string
Example
VALIDATION_ERROR
message
string
Example
Invalid request body
status
integer
Example
400
upgradeUrl

URL to upgrade plan (only present for plan limit errors)

string
Example
https://app.manako.dev/billing