Update monitor

const options = {
  method: 'PATCH',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    name: '<string>',
    icon: '<string>',
    color: '<string>',
    notifyEmails: ['<string>'],
    digestDay: '<string>',
    digestTime: '<string>',
    notifyWebhook: true,
    webhookUrl: '<string>',
    notifySlack: true,
    slackIntegrationId: '<string>',
    slackChannelId: '<string>',
    isPaused: true,
    isCollapsed: true,
    sortOrder: 123
  })
};

fetch('https://api.arcmira.com/v1/monitors/{id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://api.arcmira.com/v1/monitors/{id}"

payload = {
    "name": "<string>",
    "icon": "<string>",
    "color": "<string>",
    "notifyEmails": ["<string>"],
    "digestDay": "<string>",
    "digestTime": "<string>",
    "notifyWebhook": True,
    "webhookUrl": "<string>",
    "notifySlack": True,
    "slackIntegrationId": "<string>",
    "slackChannelId": "<string>",
    "isPaused": True,
    "isCollapsed": True,
    "sortOrder": 123
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.patch(url, json=payload, headers=headers)

print(response.text)

curl --request PATCH \
  --url https://api.arcmira.com/v1/monitors/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "icon": "<string>",
  "color": "<string>",
  "notifyEmails": [
    "<string>"
  ],
  "digestDay": "<string>",
  "digestTime": "<string>",
  "notifyWebhook": true,
  "webhookUrl": "<string>",
  "notifySlack": true,
  "slackIntegrationId": "<string>",
  "slackChannelId": "<string>",
  "isPaused": true,
  "isCollapsed": true,
  "sortOrder": 123
}
'

{
  "monitor": {
    "id": "<string>",
    "name": "<string>",
    "isCollapsed": true,
    "isPaused": true,
    "sortOrder": 123,
    "notifyEmails": [
      "<string>"
    ],
    "notifyWebhook": true,
    "webhookUrl": "<string>",
    "webhookSecretSet": true,
    "webhookSecretHint": "<string>",
    "webhookDisabledAt": "<string>",
    "webhookDisabledReason": "<string>",
    "notifySlack": true,
    "slackIntegrationId": "<string>",
    "slackChannelId": "<string>",
    "createdAt": "<string>",
    "updatedAt": "<string>",
    "trackerCount": 123,
    "icon": "eye",
    "color": "blue",
    "notifyFrequency": "realtime",
    "digestDay": "monday",
    "digestTime": "09:00",
    "webhookFailures": 0,
    "webhookSecret": "<string>"
  },
  "message": "<string>"
}

{
  "error": {
    "type": "<string>",
    "code": "<string>",
    "message": "<string>",
    "doc_url": "<string>",
    "request_id": "<string>",
    "param": "<string>"
  }
}

{
  "error": {
    "type": "<string>",
    "code": "<string>",
    "message": "<string>",
    "doc_url": "<string>",
    "request_id": "<string>",
    "param": "<string>"
  }
}

{
  "error": {
    "type": "<string>",
    "code": "<string>",
    "message": "<string>",
    "doc_url": "<string>",
    "request_id": "<string>",
    "param": "<string>"
  }
}

{
  "error": {
    "type": "<string>",
    "code": "<string>",
    "message": "<string>",
    "doc_url": "<string>",
    "request_id": "<string>",
    "param": "<string>"
  }
}

{
  "error": {
    "type": "<string>",
    "code": "<string>",
    "message": "<string>",
    "doc_url": "<string>",
    "request_id": "<string>",
    "param": "<string>"
  }
}

{
  "error": {
    "type": "<string>",
    "code": "<string>",
    "message": "<string>",
    "doc_url": "<string>",
    "request_id": "<string>",
    "param": "<string>"
  }
}

{
  "error": {
    "type": "<string>",
    "code": "<string>",
    "message": "<string>",
    "doc_url": "<string>",
    "request_id": "<string>",
    "param": "<string>"
  }
}

{
  "error": {
    "type": "<string>",
    "code": "<string>",
    "message": "<string>",
    "doc_url": "<string>",
    "request_id": "<string>",
    "param": "<string>"
  }
}

Monitors

Update monitor

A PATCH that newly enables webhook signing (turns notifyWebhook on, or sets a webhookUrl where no secret existed before) returns the signing secret (monitor.webhookSecret) in this response. Returned only once. Store it securely; it cannot be retrieved later. To recover from a lost secret, rotate. Unrelated PATCHes expose only webhookSecretSet and webhookSecretHint. PATCHing notifyWebhook: true also re-enables a webhook that was auto-disabled after repeated failures and resets its failure counter. Supports the Idempotency-Key header.

PATCH

monitors

{id}

Update monitor

const options = {
  method: 'PATCH',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    name: '<string>',
    icon: '<string>',
    color: '<string>',
    notifyEmails: ['<string>'],
    digestDay: '<string>',
    digestTime: '<string>',
    notifyWebhook: true,
    webhookUrl: '<string>',
    notifySlack: true,
    slackIntegrationId: '<string>',
    slackChannelId: '<string>',
    isPaused: true,
    isCollapsed: true,
    sortOrder: 123
  })
};

fetch('https://api.arcmira.com/v1/monitors/{id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://api.arcmira.com/v1/monitors/{id}"

payload = {
    "name": "<string>",
    "icon": "<string>",
    "color": "<string>",
    "notifyEmails": ["<string>"],
    "digestDay": "<string>",
    "digestTime": "<string>",
    "notifyWebhook": True,
    "webhookUrl": "<string>",
    "notifySlack": True,
    "slackIntegrationId": "<string>",
    "slackChannelId": "<string>",
    "isPaused": True,
    "isCollapsed": True,
    "sortOrder": 123
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.patch(url, json=payload, headers=headers)

print(response.text)

curl --request PATCH \
  --url https://api.arcmira.com/v1/monitors/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "icon": "<string>",
  "color": "<string>",
  "notifyEmails": [
    "<string>"
  ],
  "digestDay": "<string>",
  "digestTime": "<string>",
  "notifyWebhook": true,
  "webhookUrl": "<string>",
  "notifySlack": true,
  "slackIntegrationId": "<string>",
  "slackChannelId": "<string>",
  "isPaused": true,
  "isCollapsed": true,
  "sortOrder": 123
}
'

{
  "monitor": {
    "id": "<string>",
    "name": "<string>",
    "isCollapsed": true,
    "isPaused": true,
    "sortOrder": 123,
    "notifyEmails": [
      "<string>"
    ],
    "notifyWebhook": true,
    "webhookUrl": "<string>",
    "webhookSecretSet": true,
    "webhookSecretHint": "<string>",
    "webhookDisabledAt": "<string>",
    "webhookDisabledReason": "<string>",
    "notifySlack": true,
    "slackIntegrationId": "<string>",
    "slackChannelId": "<string>",
    "createdAt": "<string>",
    "updatedAt": "<string>",
    "trackerCount": 123,
    "icon": "eye",
    "color": "blue",
    "notifyFrequency": "realtime",
    "digestDay": "monday",
    "digestTime": "09:00",
    "webhookFailures": 0,
    "webhookSecret": "<string>"
  },
  "message": "<string>"
}

{
  "error": {
    "type": "<string>",
    "code": "<string>",
    "message": "<string>",
    "doc_url": "<string>",
    "request_id": "<string>",
    "param": "<string>"
  }
}

{
  "error": {
    "type": "<string>",
    "code": "<string>",
    "message": "<string>",
    "doc_url": "<string>",
    "request_id": "<string>",
    "param": "<string>"
  }
}

{
  "error": {
    "type": "<string>",
    "code": "<string>",
    "message": "<string>",
    "doc_url": "<string>",
    "request_id": "<string>",
    "param": "<string>"
  }
}

{
  "error": {
    "type": "<string>",
    "code": "<string>",
    "message": "<string>",
    "doc_url": "<string>",
    "request_id": "<string>",
    "param": "<string>"
  }
}

{
  "error": {
    "type": "<string>",
    "code": "<string>",
    "message": "<string>",
    "doc_url": "<string>",
    "request_id": "<string>",
    "param": "<string>"
  }
}

{
  "error": {
    "type": "<string>",
    "code": "<string>",
    "message": "<string>",
    "doc_url": "<string>",
    "request_id": "<string>",
    "param": "<string>"
  }
}

{
  "error": {
    "type": "<string>",
    "code": "<string>",
    "message": "<string>",
    "doc_url": "<string>",
    "request_id": "<string>",
    "param": "<string>"
  }
}

{
  "error": {
    "type": "<string>",
    "code": "<string>",
    "message": "<string>",
    "doc_url": "<string>",
    "request_id": "<string>",
    "param": "<string>"
  }
}

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json

name

string

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

Required string length: 1 - 100

icon

string

Kebab-case Lucide icon name. Default "eye".

color

string

Dashboard palette color name. Default "blue"; the valid names are returned as colors[] on GET /v1/monitors.

notifyEmails

string[]

Email recipients for alert delivery. Default [].

notifyFrequency

enum<string>

Delivery cadence. Default realtime. Values: realtime (as analysis completes), hourly (hourly digest), daily (daily digest). Free-tier email delivery is coerced to daily regardless of the value sent.

Available options:

realtime,

hourly,

daily

digestDay

string

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

digestTime

string

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

notifyWebhook

boolean

Enable HMAC-signed webhook delivery (paid plans). When enabled together with webhookUrl, the response returns the signing secret (monitor.webhookSecret) exactly once. PATCHing true also re-enables an auto-disabled webhook and resets its failure counter.

webhookUrl

string

Destination URL for webhook alert deliveries.

notifySlack

boolean

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

slackIntegrationId

string

Slack integration id from the dashboard OAuth flow.

slackChannelId

string

Slack channel id to deliver to.

isPaused

boolean

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

isCollapsed

boolean

Dashboard display state.

sortOrder

integer

Dashboard sort position.

{key}

any

Response

Success

monitor

object

required

Show child attributes

message

string

required

Human-readable confirmation.

Create monitor Delete monitor