`PUT /rules/by-key/{key}` — create the rule with this key, or make it match the body (ADR-0072 §2). A full replacement, and idempotent: a body that matches the stored rule changes nothing.

PUT/rules/by-key/{key}

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

alerting?null|

description?string|null

enabled?boolean|null

key?|

A caller-chosen identity for a rule managed as code (ADR-0072 §2): lowercase letters, digits, ., _ and -, starting and ending with a letter or digit, at most 100 characters, unique in the organization. Fixed once set. PUT /rules/by-key/{key} creates or updates by it.

name*string

owner_team_id?string|null

query?null|

schedule?string|null

status?null|

Response Body

`application/json`

curl -X PUT "https://example.com/rules/by-key/string" \  -H "Content-Type: application/json" \  -d '{    "name": "string"  }'

{  "alerting": null,  "covered_through": "string",  "created_at": "string",  "description": "string",  "enabled": true,  "id": "string",  "key": "string",  "last_run_at": "string",  "last_run_status": null,  "managed_by": "string",  "muted_until": "string",  "name": "string",  "next_run_at": "string",  "org_id": "string",  "owner_team_id": "string",  "query": null,  "schedule": "string",  "status": null,  "updated_at": "string"}

`PUT /rules/by-key/{key}` — create the rule with this key, or make it match the body (ADR-0072 §2). A full replacement, and idempotent: a body that matches the stored rule changes nothing.

Path Parameters

Request Body

Response Body

200application/json

201application/json

400

409

`application/json`

`application/json`