Skip to main content
PATCH
/
v1
/
trackers
/
{id}
Update tracker
const options = {
  method: 'PATCH',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    displayName: '<string>',
    notifyEmail: true,
    notifyWebhook: true,
    notifySlack: true,
    webhookUrl: '<string>',
    slackChannelId: '<string>',
    slackIntegrationId: '<string>',
    filters: {},
    paused: true
  })
};

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

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

payload = {
"displayName": "<string>",
"notifyEmail": True,
"notifyWebhook": True,
"notifySlack": True,
"webhookUrl": "<string>",
"slackChannelId": "<string>",
"slackIntegrationId": "<string>",
"filters": {},
"paused": True
}
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/trackers/{id} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"displayName": "<string>",
"notifyEmail": true,
"notifyWebhook": true,
"notifySlack": true,
"webhookUrl": "<string>",
"slackChannelId": "<string>",
"slackIntegrationId": "<string>",
"filters": {},
"paused": true
}
'
{
  "tracker": {
    "id": "<string>",
    "entityName": "<string>",
    "entityType": "<string>",
    "displayName": "<string>",
    "notifyEmail": true,
    "notifyWebhook": true,
    "notifySlack": true,
    "webhookUrl": "<string>",
    "slackChannelId": "<string>",
    "slackIntegrationId": "<string>",
    "filters": {},
    "isPaused": true,
    "pausedAt": "<string>",
    "lastNotifiedAt": "<string>",
    "createdAt": "<string>",
    "updatedAt": "<string>",
    "emailDeliveryCount": 123,
    "webhookDeliveryCount": 123,
    "slackDeliveryCount": 123,
    "monitorId": "<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
displayName
string

Optional label shown in alerts and the dashboard.

notifyEmail
boolean

Per-tracker email delivery. Default true.

notifyWebhook
boolean

Per-tracker webhook delivery override. Paid plans only.

notifySlack
boolean

Per-tracker Slack delivery override. Paid plans only.

webhookUrl
string

Per-tracker webhook destination override (http/https).

slackChannelId
string

Per-tracker Slack channel override.

slackIntegrationId
string

Per-tracker Slack integration override.

filters
object

Optional matching filters, stored and applied at alert time.

paused
boolean

Pause or resume the tracker. Paused trackers stop producing alerts; there is no backfill for the paused window.

{key}
any

Response

Success

tracker
object
required
message
string
required

Human-readable confirmation.