Skip to content
BleemeoBleemeo

Partially update a recording rule

PATCH
/v1/recordingrule/{id}/
curl --request PATCH \
  --url https://example.com/v1/recordingrule/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/ \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "name": "example", "query": "example", "agent_type": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "default_threshold_high_critical": 1, "default_threshold_high_warning": 1, "default_threshold_low_critical": 1, "default_threshold_low_warning": 1, "active": true, "deactivated_at": "2026-04-15T12:00:00Z" }'

Update one or more fields of an existing recording rule.

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Path Parameters

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

A UUID string identifying this recording rule.

Request Body

Section titled “Request Body”

A ModelSerializer that takes an additional fields argument that controls which fields should be displayed.

object
id
string format: uuid
account
string format: uuid
name
string
<= 100 characters
query
string
<= 1000 characters
agent_type
string format: uuid
nullable
metric_resolution_second
integer
default_threshold_high_critical
Threshold high critical
number format: double
nullable
default_threshold_high_warning
Threshold high warning
number format: double
nullable
default_threshold_low_critical
Threshold low critical
number format: double
nullable
default_threshold_low_warning
Threshold low warning
number format: double
nullable
active
boolean
created_at
string format: date-time
deactivated_at
string format: date-time
nullable
Examplegenerated
{
  "name": "example",
  "query": "example",
  "agent_type": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
  "default_threshold_high_critical": 1,
  "default_threshold_high_warning": 1,
  "default_threshold_low_critical": 1,
  "default_threshold_low_warning": 1,
  "active": true,
  "deactivated_at": "2026-04-15T12:00:00Z"
}

Responses

Section titled “Responses”

200

Section titled “200”
Media typeapplication/json

A ModelSerializer that takes an additional fields argument that controls which fields should be displayed.

object
id
required
string format: uuid
account
required
string format: uuid
name
required
string
<= 100 characters
query
required
string
<= 1000 characters
agent_type
string format: uuid
nullable
metric_resolution_second
required
integer
default_threshold_high_critical
Threshold high critical
number format: double
nullable
default_threshold_high_warning
Threshold high warning
number format: double
nullable
default_threshold_low_critical
Threshold low critical
number format: double
nullable
default_threshold_low_warning
Threshold low warning
number format: double
nullable
active
boolean
created_at
required
string format: date-time
deactivated_at
string format: date-time
nullable
Examplegenerated
{
  "name": "example",
  "query": "example",
  "agent_type": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
  "default_threshold_high_critical": 1,
  "default_threshold_high_warning": 1,
  "default_threshold_low_critical": 1,
  "default_threshold_low_warning": 1,
  "active": true,
  "deactivated_at": "2026-04-15T12:00:00Z"
}