コンテンツにスキップ
Framedash Docs

Update an alert rule

PATCH
/v1/projects/{id}/alerts/{alertId}

Partially updates an alert rule. All fields are optional. To reactivate a deactivated rule, set isActive: true (subject to plan quota).

Authorizations

Section titled “Authorizations ”

Parameters

Section titled “ Parameters ”

Path Parameters

Section titled “Path Parameters ”
id
required
string format: uuid

Project UUID.

alertId
required
string format: uuid

Alert rule UUID.

Request Body required

Section titled “Request Body required ”

Partial update for an alert rule. All fields are optional.

object
name
string
mapId
string format: uuid
thresholdProfileId
string format: uuid
metric
string
Allowed values: fps frame_time memory gpu_time
thresholdLevel
string
Allowed values: warn good
failPercentage
number
>= 1 <= 100
evaluationDays
integer
cellSize
integer
Allowed values: 5 10 25 50
cooldownMinutes
integer
>= 1
channelIds
Array<string>
isActive

Set to true to reactivate (subject to plan quota) or false to deactivate.

boolean

Responses

Section titled “ Responses ”

200

Section titled “200 ”

Alert rule updated.

object
success
boolean
data

Full alert rule including timestamps and channel IDs.

object
id
string format: uuid
projectId
string format: uuid
mapId
string format: uuid
thresholdProfileId
string format: uuid
name
string
metric
string
Allowed values: fps frame_time memory gpu_time
thresholdLevel
string
Allowed values: warn good
failPercentage
number
evaluationDays
integer
cellSize
integer
cooldownMinutes
integer
isActive
boolean
createdAt
string format: date-time
updatedAt
string format: date-time
channelIds
Array<string>

400

Section titled “400 ”

Invalid request parameters or body.

object
success
boolean
error

Human-readable error message.

string

401

Section titled “401 ”

Missing or invalid API key.

object
success
boolean
error

Human-readable error message.

string

403

Section titled “403 ”

Plan limit reached (e.g., reactivating when at max rules).

object
success
boolean
error

Human-readable error message.

string

404

Section titled “404 ”

Resource not found.

object
success
boolean
error

Human-readable error message.

string

429

Section titled “429 ”

Rate limit exceeded.

object
success
boolean
error

Human-readable error message.

string

Headers

Section titled “Headers ”
X-RateLimit-Limit
integer

Maximum number of requests allowed per hour.

X-RateLimit-Remaining
integer

Number of requests remaining in the current window.

X-RateLimit-Reset
integer

Unix timestamp when the rate limit window resets.