Sign in
Monitors

Update monitor

Updates a monitor's name and description. System monitors cannot be edited.

patch/v1/projects/{projectSlug}/monitors/{monitorSlug}

Path parameters

projectSlugstring required

Project slug (human-readable identifier)

Project slug (human-readable identifier)

monitorSlugstring required

Monitor slug (human-readable identifier within the project).

Monitor slug (human-readable identifier within the project).

Request body

namestring

New name. Renaming may regenerate the slug — re-read the response or rely on id.

descriptionstring

New description.

Response

Updated monitor

idstring required

Stable monitor identifier.

organizationIdstring required

Organization that owns this monitor.

projectIdstring required

Project this monitor belongs to.

slugstring required

URL-safe slug derived from name. Unique within the project.

namestring required

Human-readable name.

descriptionstring required

Free-form description. Empty string when not set.

systemboolean required

true for the auto-provisioned system monitors, which can't be deleted or edited; false otherwise.

mutedAtstring nullable required

ISO-8601 timestamp at which the monitor was muted, or null when active.

deletedAtstring nullable required

ISO-8601 timestamp at which the monitor was deleted, or null.

createdAtstring required

ISO-8601 timestamp of creation.

updatedAtstring required

ISO-8601 timestamp of the last update.

Changes