Skip to main content
PATCH
Edit a monitor

Authorizations

Authorization
string
header
required

An API key, sent as Authorization: Bearer <key>. An organization admin creates one in the Trunk app under Settings → Developer → API Keys and chooses the permissions it holds. A key with none can read merge queues but change nothing in them. Permissions cover merge queues and test-result uploads, including the quarantine lookups a CI run makes before it uploads; any key can call the other Flaky Tests and Dynamic CI endpoints, including their writes.

Path Parameters

monitorId
string
required

The monitor's id.

Minimum string length: 1
Example:

"1a2b3c4d-5e6f-4a1b-8c9d-0e1f2a3b4c5d"

Body

application/json

A merge patch. monitorType cannot change, and sending it is a 400.

name
string

Leading and trailing spaces are removed.

Required string length: 1 - 200
Example:

"Broken on main"

enabled
boolean
Example:

false

config
object

Fields of the monitor's own type to change; any field left out keeps its value, and null unsets an optional one. A config valid only for another type is a 422; one mixing fields of two types is a 400.

Response

The monitor after the edit

A monitor on one test collection. config holds the fields of its monitorType.

id
string
required
Example:

"1a2b3c4d-5e6f-4a1b-8c9d-0e1f2a3b4c5d"

testCollectionId
string
required

The id of the test collection the monitor belongs to.

Example:

"aB3xY9kQ"

name
string
required
Example:

"Broken on main"

enabled
boolean
required
Example:

true

activeTestCount
integer
required

Tests the monitor is active on and has not muted.

Example:

3

mutedTestCount
integer
required

Tests whose mute on this monitor is in force, whether or not the monitor is active on them.

Example:

1

actions
object[]
required

What the monitor does to a test it detects, oldest first. A label action is one entry per label. At most the first 100 are returned.

Maximum array length: 100
createdAt
string<date-time>
required
Example:

"2026-06-01T00:00:00.000Z"

updatedAt
string<date-time>
required
Example:

"2026-06-02T00:00:00.000Z"

monitorType
enum<string>
required
Available options:
failureRate
config
object
required