OrkStageOrkStage
API referenceIncidents

PATCH /alert-rules/{id}

PATCH /alert-rules/{id}: OrkStage Control API v1 endpoint reference.

PATCH
/api/v1/alert-rules/{id}

Authorization

headerAuthorizationBearer <ork_<env>_<id>_<secret>>

Organization API key (scoped). Sessions use the cookie instead.

Path Parameters

id*string

Header Parameters

x-orkstage-csrf?unknown

Cookie sessions: send "1" on POST/PATCH/PUT/DELETE. Not needed with an API key.

Request Body

application/json
  1. body
name?string
Length2 <= length <= 120
condition?|
severity?string
Default"medium"
Value in"low""medium""high""critical"
actions?array<>
Items1 <= items
Default
[  "create_incident",  "notify_owners"]
cooldownSeconds?integer
Range0 <= value <= 86400
Default900
autoResolve?boolean
Defaulttrue
enabled?boolean
Defaulttrue

Response Body

Example Request
curl -X PATCH 'http://localhost:4000/api/v1/alert-rules/string' \  -H 'Content-Type: application/json' \  -d '{}'
Example Response200
Empty
Edit on GitHub

POST /alert-rules POST

POST /alert-rules: OrkStage Control API v1 endpoint reference.

DELETE /alert-rules/{id} DELETE

DELETE /alert-rules/{id}: OrkStage Control API v1 endpoint reference.