Sign in
Monitors

Update monitor

A PATCH that newly enables webhook signing (turns notify_webhook on, or sets a webhook_url where no secret existed before) returns the signing secret (monitor.webhook_secret) in this response. Store it securely. A retry with the original Idempotency-Key recovers the same secret for up to 24 hours while it remains the current secret or the valid previous secret. An expired or displaced secret returns 409 idempotency_result_expired without rotating again. Reads do not expose the secret. Unrelated PATCHes expose only webhook_secret_set and webhook_secret_hint. PATCHing notify_webhook: true also re-enables a webhook that was auto-disabled after repeated failures and resets its failure counter.

patch/v1/monitors/{id}

Request

  • Base URL: https://api.arcmira.com
  • URL: https://api.arcmira.com/v1/monitors/{id}
  • Auth: HTTP bearer

Path parameters

idstring required

Monitor id.

Headers

Idempotency-Keystring

One key per intent, 1 to 255 printable ASCII characters (0x21 to 0x7E); anything else is 400 invalid_idempotency_key. Keys are scoped to the account, credential and resource family. The same key and normalized method, path and body returns the committed response with Idempotency-Replayed: true. A changed intent within the same family returns 409 idempotency_conflict. Monitor and tracker families have independent namespaces. Secret recovery is limited as described by the operation.

Request body

namestring

Display name (1-100 characters). Required on create.

notify_emailsstring[]

Desired email recipients. External recipients must confirm before delivery. Free includes one additional recipient per monitor; paid plans allow up to 20 total. Default [].

notify_frequency'realtime' | 'hourly' | 'daily'

Delivery cadence. Default realtime. Values: realtime (as analysis completes), hourly (hourly digest), daily (daily digest).

digest_daystring

Digest day of week. Default "monday". Consulted only by weekly digests, which are dashboard-configured today; inert for API-set frequencies.

digest_timestring

Digest send hour as HH:MM (account timezone). Default "09:00". Applies to daily digests.

notify_webhookboolean

Enable HMAC-signed webhook delivery (paid plans). When enabled together with webhook_url, the response returns the signing secret (monitor.webhook_secret), recoverable with the original Idempotency-Key during the valid recovery window. PATCHing true also re-enables an auto-disabled webhook and resets its failure counter.

webhook_urlstring

Destination URL for webhook alert deliveries.

notify_slackboolean

Enable Slack delivery. Requires a Slack integration connected in the dashboard.

slack_integration_idstring

Slack integration id from the dashboard OAuth flow.

slack_channel_idstring

Slack channel id to deliver to.

pausedboolean

Paused monitors accept config changes but do not deliver; alerts that would have fired are not queued.

Response

Success

messagestring required

Human-readable confirmation.

Changes

No recorded changes to this operation across all 1 revision of this API.