Mute a monitor's alerting
Stops this monitor declaring incidents and alerts until the given time. Probing is UNAFFECTED: checks keep running and the monitor's status keeps changing, so uptime and status pages stay truthful — only paging stops. Send alerts_muted_until for an explicit deadline, or duration_minutes for a window from now. Re-issuing replaces the current mute.
Authorization
bearerAuth An uptimely_live_ project API key (Settings → API Keys).
In: header
Path Parameters
Monitor id.
^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$uuidHeader Parameters
Optional client-generated key (1-255 visible ASCII characters; a UUID works) making this POST safely retryable. Retrying with the SAME key and byte-identical body within 24h replays the stored first response. The same key with a different body answers 422 idempotency_key_reused; a retry racing the first execution answers 409 idempotency_in_progress. Omitting the header executes normally with no idempotency guarantee.
1 <= length <= 255Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Exactly one of alerts_muted_until or duration_minutes is required.
Response Body
application/json
application/problem+json
application/problem+json
application/problem+json
application/problem+json
application/problem+json
application/problem+json
application/problem+json
application/problem+json
curl -X POST "https://example.com/v1/monitors/497f6eca-6276-4993-bfeb-53cbbbba6f08/mute" \ -H "Content-Type: application/json" \ -d '{}'{ "monitor_id": "ff93e0f3-22fc-4809-8875-a2d24a9803b1", "alerts_muted_until": "2019-08-24T14:15:22Z"}