API-referens för övervakare

Monitors

Check the uptime of your websites, APIs, and services

Cron Monitors

Monitor your scheduled jobs via HTTP pings

Möjliga värden för fält

Övervakarens plats

Värde	Beskrivning
`US_EAST_1`	N. Virginia
`CA_CENTRAL_1`	Kanada (Montreal)
`EU_CENTRAL_1`	Frankfurt
`AP_NORTHEAST_1`	Tokyo

Typer av övervakningsaviseringar

Värde	Beskrivning
`INCIDENT`	Incidentavisering
`EMAIL`	E-postavisering
`SMS`	SMS-avisering
`SLACK`	Slack-avisering
`DISCORD`	Discord-avisering
`MICROSOFT_TEAMS`	Microsoft Teams-avisering
`PHONE_CALL`	Avisering via telefonsamtal
`WEBHOOK`	Webhook-avisering
`GOOGLE_CHAT`	Google Chat-avisering
`WHATSAPP`	WhatsApp-avisering

Övervakarens status

Värde	Beskrivning
`UP`	Övervakaren fungerar normalt
`DOWN`	Övervakaren har fallerat
`DEGRADED`	Övervakaren har problem
`UNKNOWN`	Övervakarens tillstånd går inte att avgöra

Övervakarens tillstånd

Värde	Beskrivning
`ACTIVE`	Övervakaren kör kontroller och skickar aviseringar
`MUTED`	Övervakaren kör kontroller men skickar inga aviseringar
`PAUSED`	Övervakaren kör inga kontroller

Hämta övervakare

Du kan använda den här endpointen för att hitta och bläddra i en lista över alla befintliga övervakare.

Endpoint:

GET /:page_id/monitors

Query-parametrar

Parameter	Typ	Standardvärde	Beskrivning
`page`	`number`	`1`	Sidnumret som ska hämtas.
`limit`	`number`	`100`	Antal övervakare per sida.
`search`	`string`	`null`	Sökterm för att filtrera resultaten.
`status`	`enum`	`null`	Statusfilter ('UP', 'DOWN', 'UNKNOWN', 'DEGRADED').

Exempelanrop

GET /1/monitors?limit=3&page=2&status=DOWN

Exempelsvar

{
  "monitors": [{ "...": "monitor objects" }],
  "total": 10,
  "page": 3,
  "totalPages": 5,
  "limit": 2
}

Skapa en övervakare

Endpoint:

POST /monitors

Exempelanrop

{
  "pageId": "page123",
  "url": "https://example.com",
  "httpMethod": "GET",
  "body": null,
  "headers": {
    "Content-Type": "application/json",
    "Authorization": "Bearer token"
  },
  "queryParams": {
    "search": "test",
    "limit": "10"
  },
  "basicAuth": {
    "username": "user",
    "password": "password"
  },
  "type": "HTTP",
  "assertions": [
    {
      "type": "STATUSCODE",
      "comparison": "EQUALS",
      "selector": null,
      "target": "200"
    }
  ],
  "alerts": ["alert-id-1", "alert-id-2"],
  "name": "Example Monitor",
  "locations": "US_EAST_1",
  "checksInterval": 300,
  "createComponent": true,
  "createMetric": true,
  "onFail": {
    "createIncident": true,
    "createOutageDuration": true,
    "publishIncident": true,
    "notifySubscribers": true
  },
  "onRecover": {
    "resolveIncident": true,
    "resolveOutageDuration": true,
    "publishIncident": true,
    "notifySubscribers": true
  }
}

Exempelsvar

{
  "monitor": {
    "pageId": "page123",
    "url": "https://example.com",
    "httpMethod": "GET",
    "body": null,
    "headers": {
      "Content-Type": "application/json",
      "Authorization": "Bearer token"
    },
    "queryParams": {
      "search": "test",
      "limit": "10"
    },
    "basicAuth": {
      "username": "user",
      "password": "password"
    },
    "type": "HTTP",
    "assertions": [
      {
        "id": "assertion1",
        "type": "STATUSCODE",
        "comparison": "EQUALS",
        "selector": null,
        "target": "200"
      }
    ],
    "alerts": ["alert1", "alert2"],
    "name": "Example Monitor",
    "locations": "US_EAST_1",
    "checksInterval": 300,
    "createComponent": true,
    "createMetric": true,
    "onFail": {
      "createIncident": true,
      "createOutageDuration": true,
      "publishIncident": true,
      "notifySubscribers": true
    },
    "onRecover": {
      "resolveIncident": true,
      "resolveOutageDuration": true,
      "publishIncident": true,
      "notifySubscribers": true
    },
    "createdAt": "2023-08-08T12:00:00Z",
    "updatedAt": "2023-08-08T12:00:00Z"
  },
  "message": "Monitor created successfully"
}

Uppdatera en övervakare

Endpoint:

PUT /monitors/:id

Exempelanrop

{
  "url": "https://updated.com",
  "name": "Updated Monitor Name"
}

Exempelsvar

{
  "monitor": {
    "pageId": "page123",
    "url": "https://updated.com",
    "httpMethod": "GET",
    "body": null,
    "headers": {
      "Content-Type": "application/json",
      "Authorization": "Bearer token"
    },
    "queryParams": {
      "search": "test",
      "limit": "10"
    },
    "basicAuth": {
      "username": "user",
      "password": "password"
    },
    "type": "HTTP",
    "assertions": [
      {
        "id": "assertion1",
        "type": "STATUSCODE",
        "comparison": "EQUALS",
        "selector": null,
        "value": "200"
      }
    ],
    "alerts": ["alert1", "alert2"],
    "name": "Updated Monitor Name",
    "locations": "US_EAST_1",
    "checksInterval": 300,
    "createComponent": true,
    "createMetric": true,
    "onFail": {
      "createIncident": true,
      "createOutageDuration": true,
      "publishIncident": true,
      "notifySubscribers": true
    },
    "onRecover": {
      "resolveIncident": true,
      "resolveOutageDuration": true,
      "publishIncident": true,
      "notifySubscribers": true
    },
    "createdAt": "2023-08-08T12:00:00Z",
    "updatedAt": "2023-08-08T12:00:00Z"
  },
  "message": "Monitor updated successfully"
}

Uppdatera tillståndet för en övervakare

Återuppta, tysta eller pausa en övervakare, precis som i statusmenyn i dashboarden. En tystad övervakare fortsätter att kontrollera men skickar inga aviseringar, kör inga dirigeringsregler och meddelar inte prenumeranter. En pausad övervakare slutar kontrollera tills du sätter tillbaka den till ACTIVE.

Endpoint:

PUT /monitors/:id/state

Body-parametrar

Parameter	Typ	Beskrivning
`state`	`enum`	Obligatorisk. Det nya tillståndet ('ACTIVE', 'MUTED', 'PAUSED').
`forMinutes`	`number`	Valfri, bara med `MUTED`. Häver tystningen efter så många minuter, högst `10080` (7 dagar). Utelämna den för att hålla övervakaren tystad tills du ändrar tillståndet igen.

Exempelanrop

{
  "state": "MUTED",
  "forMinutes": 60
}

Exempelsvar

{
  "id": "monitor-id-1",
  "state": "MUTED",
  "message": "Monitor state updated successfully."
}

Övervakare från Hämta övervakare visar sitt nuvarande tillstånd i fälten active, muted och mutedUntil. En pausad övervakare har active: false. En tystad övervakare har active: true och muted: true, och mutedUntil anger när en tidsbegränsad tystning slutar.

Radera en övervakare

Endpoint:

DELETE /monitors/:id

Exempelanrop

DELETE /monitors/monitor-id-1

Exempelsvar

{
  "message": "Monitor deleted successfully."
}

Hämta övervakningsloggar

Endpoint:

GET /monitors/:id/logs

Query-parametrar

Parameter	Typ	Standardvärde	Beskrivning
`limit`	`number`	100	Antal poster per sida. Får inte överstiga 1000.
`page`	`number`	1	Sidnumret som ska hämtas.
`from`	`string`	ett år sedan	Endast resultat vid eller efter denna ISO 8601-tid. Högst ett år tillbaka.
`to`	`string`	`null`	Endast resultat vid eller före denna ISO 8601-tid.
`monitorId`	`string`	-	Övervakarens ID.
`location`	`string`	`null`	Övervakarens plats.
`createdAt`	`string` \| `object` \| `number`	`null`	Skapandedatum. Kan vara en sträng, ett tal eller ett objekt med fälten `gte` och `lte`.
`isSuccessful`	`boolean`	`null`	Om kontrollen lyckades.
`isSSLCheck`	`boolean`	`null`	Om kontrollen är en SSL-kontroll.
`httpStatusCode`	`string`	`null`	Svarets HTTP-statuskod.
`status`	`('UP', 'DOWN', 'UNKNOWN', 'DEGRADED')`	`null`	Övervakarens status.
`dnsTime`	`string` \| `number` \| `object`	`null`	Tid för DNS-uppslag.
`tcpTime`	`string` \| `number` \| `object`	`null`	Tid för TCP-anslutning.
`tlsTime`	`string` \| `number` \| `object`	`null`	Tid för TLS-handskakning.
`firstByteTime`	`string` \| `number` \| `object`	`null`	Tid till första byten togs emot.
`downloadTime`	`string` \| `number` \| `object`	`null`	Tid för nedladdningen.
`responseTime`	`string` \| `number` \| `object`	`null`	Total svarstid.
`performanceTime`	`string` \| `number` \| `object`	`null`	Prestandatid.
`accessabilityScore`	`string` \| `number` \| `object`	`null`	Tillgänglighetspoäng.
`seoScore`	`string` \| `number` \| `object`	`null`	SEO-poäng.
`bestPracticesScore`	`string` \| `number` \| `object`	`null`	Poäng för best practices.
`successfulAssertions`	`string` \| `number` \| `object`	`null`	Antal uppfyllda villkor.
`sort`	`string`	kronologiskt	Fält att sortera efter.

Exempelanrop

GET /monitors/monitor-id-1/logs?limit=100&page=1

Exempelsvar

{
  "monitorLogs": [
    // {monitor log object},
    // {monitor log object 2}
  ],
  "total": 478,
  "page": 1,
  "totalPages": 5,
  "limit": 100
}

Hämta monitorns upptid

Tillgänglighet och svarstider för en monitor över ett intervall, uppdelat per dag. Intervallet är som standard de senaste 30 dagarna och kan vara högst 395 dagar. Intervall längre än fem dagar mäts i hela dagar, och ett slut vid midnatt stannar dagen före, så start=2026-10-01T00:00:00Z&end=2026-11-01T00:00:00Z är exakt oktober.

Endpoint:

GET /monitors/:id/summary

Query-parametrar

Parameter	Typ	Standardvärde	Beskrivning
`start`	`string`	30 dagar före slut	Intervallets start, i ISO 8601.
`end`	`string`	nu	Intervallets slut, i ISO 8601.

Exempelanrop

GET /monitors/monitor-id-1/summary?start=2026-10-01T00:00:00Z&end=2026-11-01T00:00:00Z

Exempelsvar

{
  "monitorId": "monitor-id-1",
  "start": "2026-10-01T00:00:00.000Z",
  "end": "2026-10-31T23:59:59.999Z",
  "firstCheckDay": "2026-09-12",
  "availability": 99.95,
  "checks": 8928,
  "failedChecks": 4,
  "downtimeSeconds": 720,
  "avgResponseTime": 216,
  "response95": null,
  "avgDailyResponse95": 268,
  "days": [
    {
      "date": "2026-10-01",
      "availability": 100,
      "checks": 288,
      "failedChecks": 0,
      "avgResponseTime": 212
    }
  ]
}

availability är andelen lyckade kontroller, och null när det inte fanns några kontroller i intervallet.
downtimeSeconds är antalet misslyckade kontroller multiplicerat med kontrollintervallet.
firstCheckDay är den första dagen monitorn har kontroller för. När den ligger efter start gäller siffrorna bara dagarna från och med då.
days listar bara dagar som hade kontroller.

Kör en övervakningskontroll via ID

Endpoint:

GET /monitors/:id/run

Query-parametrar

Parameter	Typ	Standardvärde	Beskrivning
`location`	`'US_EAST_1', 'EU_CENTRAL_1', 'AP_NORTHEAST_1', 'AP_SOUTHEAST_2', 'CA_CENTRAL_1'`	-	Övervakarens plats. Måste vara ett av de angivna värdena.
`retry`	`boolean`	`false`	Anger om operationen ska försökas igen. Valfritt.
`monitorLogId`	`string`	`null`	Övervakningsloggens unika identifierare. Valfritt.

Exempelanrop

GET /monitors/monitor-id-1/run?monitorId=abc123&location=US_EAST_1&retry=true&monitorLogId=log456

Exempelsvar

{
  "status": "success",
  "message": "Monitor check run successfully."
}

Skapa övervakningsavisering

Endpoint:

POST /monitor-alerts

Exempelanrop

{
  "type": "EMAIL",
  "pageId": "page123",
  "recipient": "user@example.com",
  "recipientWorkspace": "workspace123",
  "whenFails": true,
  "whenRecovers": true,
  "whenDegrades": false,
  "whenSslExpires": true,
  "sslExpiresInDays": 30,
  "monitors": ["monitor1", "monitor2"],
  "metadata": "Additional information about the alert"
}

Exempelsvar

{
  "monitor": {
    "id": "alert123",
    "siteId": "site123",
    "type": "EMAIL",
    "recipient": "user@example.com",
    "whenFails": true,
    "whenRecovers": true,
    "whenDegrades": false,
    "whenSslExpires": true,
    "sslExpiresInDays": 30,
    "monitors": [{ "id": "monitor1" }, { "id": "monitor2" }],
    "createdAt": "2023-08-08T12:00:00Z",
    "updatedAt": "2023-08-08T12:00:00Z",
    "metadata": "Additional information about the alert"
  },
  "message": "Monitor Alert created successfully"
}

Uppdatera övervakningsavisering

Endpoint:

PUT /monitor-alerts/:id

Exempelanrop

{
  "type": "EMAIL",
  "monitors": ["monitor-1-id", "monitor-2-id", "monitor-3-id"]
}

Exempelsvar

{
  "monitor": {
    "type": "EMAIL",
    "pageId": "page123",
    "recipient": "user@example.com",
    "recipientWorkspace": "workspace123",
    "whenFails": true,
    "whenRecovers": true,
    "whenDegrades": false,
    "whenSslExpires": true,
    "sslExpiresInDays": 30,
    "monitors": ["monitor-1-id", "monitor-2-id"],
    "metadata": "Additional information about the alert"
  },
  "message": "Monitor alert updated successfully."
}

Hämta övervakningsaviseringar

Endpoint:

GET /:page_id/monitor-alerts

Query-parametrar

Parameter	Typ	Standardvärde	Beskrivning
`limit`	`number`	100	Antal poster per sida.
`page`	`number`	1	Sidnumret som ska hämtas.

Exempelanrop

GET /1/monitor-alerts?limit=2&page=3

Exempelsvar

{
  "monitorAlerts": [
    {...monitor alert objects}
  ],
  "total": 27,
  "page": 3,
  "totalPages": 14,
  "limit": 2
}

Radera övervakningsavisering

Endpoint:

DELETE /monitor-alerts/:id

Exempelanrop

DELETE /monitor-alerts/alert-id-1

Exempelsvar

{
  "message": "Monitor alert deleted successfully."
}

Skapa övervakningsgrupp

Endpoint:

POST /monitors-groups

Exempelanrop

{
  "pageId": "page123",
  "name": "Example Name",
  "childId": "child456"
}

Exempelsvar

{
  "monitor": {
    "id": "group123",
    "name": "Example Name",
    "siteId": "site123",
    "collapsed": false,
    "monitors": [{ "id": "monitor1" }, { "id": "monitor2" }],
    "groupId": "parentGroup123",
    "children": [
      { "id": "childGroup1", "name": "Child Group 1" },
      { "id": "childGroup2", "name": "Child Group 2" }
    ],
    "order": 1,
    "createdAt": "2023-08-08T12:00:00Z",
    "updatedAt": "2023-08-08T12:00:00Z",
    "parents": ["parent1", "parent2"],
    "componentId": "component123"
  },
  "message": "Monitor group created successfully."
}

Uppdatera övervakningsgrupp

Endpoint:

PUT /monitors-groups/:id

Exempelanrop

{
  "name": "Updated Monitor Group Name"
}

Exempelsvar

{
  "monitor": {
    "id": "group123",
    "name": "Updated Monitor Group Name",
    "siteId": "site123",
    "collapsed": true,
    "monitors": [{ "id": "monitor1" }, { "id": "monitor2" }],
    "groupId": "parentGroup123",
    "children": [
      { "id": "childGroup1", "name": "Child Group 1" },
      { "id": "childGroup2", "name": "Child Group 2" }
    ],
    "order": 1,
    "createdAt": "2023-08-08T12:00:00Z",
    "updatedAt": "2023-08-08T12:00:00Z",
    "parents": ["parent1", "parent2"],
    "componentId": "component123"
  },
  "message": "Monitor group updated successfully."
}

Radera övervakningsgrupp

Endpoint:

DELETE /monitors-groups/:id

Exempelanrop

DELETE /monitors-groups/group-id-1

Exempelsvar

{
  "message": "Monitor group deleted successfully."
}

Lägg till övervakare i en grupp

Endpoint:

POST /monitors-groups/:id/monitors

Exempelanrop

{
  "monitors": ["monitor1", "monitor2", "monitor3"]
}

Exempelsvar

{
  "message": "Monitors added to the group successfully."
}

Kör kontroll för en övervakningsgrupp

Endpoint:

GET /monitors-groups/:id/run

Query-parametrar

Parameter	Typ	Standardvärde	Beskrivning
`location`	`'US_EAST_1', 'EU_CENTRAL_1', 'AP_NORTHEAST_1', 'AP_SOUTHEAST_2', 'CA_CENTRAL_1'`	-	Övervakarens plats. Måste vara ett av de angivna värdena.
`retry`	`boolean`	`false`	Anger om operationen ska försökas igen. Valfritt.
`monitorLogId`	`string`	`null`	Övervakningsloggens unika identifierare. Valfritt.

Exempelanrop

GET /monitors-groups/group-id-1/run

Exempelsvar

{
  "result": "OK",
  "monitorLogId": "monitor-log-id-1"
}

Cron-övervakare

Cron-övervakare håller koll på schemalagda jobb via HTTP-pingar. För uppsättning i produkten och användning i dashboarden, se Cron-övervakning.

Möjliga värden för fält

Status för cron-övervakare

Värde	Beskrivning
`UP`	Övervakaren fungerar normalt
`DOWN`	Övervakaren har fallerat
`DEGRADED`	Övervakaren har problem
`UNKNOWN`	Övervakarens tillstånd går inte att avgöra

Tillstånd för cron-övervakare

Värde	Beskrivning
`ACTIVE`	Övervakaren kontrolleras aktivt
`PAUSED`	Övervakarens kontroller är pausade
`MUTED`	Övervakaren är tystad (inga aviseringar)

Loggstatus för cron-övervakare

Värde	Beskrivning
`SUCCESS`	Jobbet slutfördes
`FAILURE`	Jobbet rapporterade uttryckligen ett fel
`MISSED`	Jobbet pingade inte inom det förväntade fönstret
`LATE`	Jobbet pingade efter perioden men inom respiten
`STARTED`	Jobbet rapporterade att det startade (körtidsmätning)

Period och respit

Både period och grace anges i sekunder. period är hur ofta jobbet ska köras; grace är extra tid som tillåts innan övervakaren markeras som nere.

Hämta cron-övervakare

Endpoint:

GET /:page_id/monitors/cron

Query-parametrar

Parameter	Typ	Standardvärde	Beskrivning
`limit`	`number`	`100`	Antal cron-övervakare per sida. Max är 100.
`page`	`number`	`1`	Sidnumret.
`search`	`string`	`null`	Sökterm för att filtrera resultaten på namn.
`status`	`enum`	`null`	Statusfilter ('UP', 'DOWN', 'UNKNOWN', 'DEGRADED').

Exempelanrop

GET /page123/monitors/cron?limit=10&page=1&status=DOWN

Exempelsvar

{
  "cronMonitors": [
    {
      "id": "cron-abc123",
      "name": "Daily backup",
      "slug": "my-page-x7k2m9n4p1q8w3e5",
      "period": 86400,
      "grace": 3600,
      "status": "UP",
      "state": "ACTIVE",
      "siteId": "page123",
      "order": 1,
      "groupId": null,
      "componentId": "component-id-1",
      "onFailCreateIncident": true,
      "onFailCreateOutageDuration": false,
      "onFailPublishIncident": true,
      "onFailNotifySubscribers": true,
      "onRecoverResolveIncident": true,
      "onRecoverResolveOutageDuration": false,
      "onRecoverPublishIncident": true,
      "onRecoverNotifySubscribers": true,
      "createTemplateId": null,
      "resolveTemplateId": null,
      "createdAt": "2024-01-15T08:00:00.000Z",
      "updatedAt": "2024-01-15T08:00:00.000Z"
    }
  ],
  "total": 1,
  "page": 1,
  "totalPages": 1,
  "limit": 10
}

Skapa en cron-övervakare

Endpoint:

POST /monitors/cron

Exempelanrop

{
  "pageId": "page123",
  "name": "Daily backup",
  "period": 86400,
  "grace": 3600,
  "alerts": ["alert-id-1", "alert-id-2"],
  "createComponent": true,
  "onFail": {
    "createIncident": true,
    "createOutageDuration": false,
    "publishIncident": true,
    "notifySubscribers": true
  },
  "onRecover": {
    "resolveIncident": true,
    "resolveOutageDuration": false,
    "publishIncident": true,
    "notifySubscribers": true
  }
}

Exempelsvar

{
  "cronMonitor": {
    "id": "cron-abc123",
    "name": "Daily backup",
    "slug": "my-page-x7k2m9n4p1q8w3e5",
    "period": 86400,
    "grace": 3600,
    "status": "UP",
    "state": "ACTIVE",
    "siteId": "page123",
    "order": 1,
    "groupId": null,
    "componentId": "component-id-1",
    "onFailCreateIncident": true,
    "onFailCreateOutageDuration": false,
    "onFailPublishIncident": true,
    "onFailNotifySubscribers": true,
    "onRecoverResolveIncident": true,
    "onRecoverResolveOutageDuration": false,
    "onRecoverPublishIncident": true,
    "onRecoverNotifySubscribers": true,
    "createTemplateId": null,
    "resolveTemplateId": null,
    "createdAt": "2024-01-15T08:00:00.000Z",
    "updatedAt": "2024-01-15T08:00:00.000Z"
  },
  "message": "Cron monitor created successfully."
}

Svaret innehåller en slug. Använd den för att bygga ping-URL:er för ditt jobb. Den första lyckade pingen schemalägger bakgrundskontrollen.

Uppdatera en cron-övervakare

Endpoint:

PUT /monitors/cron/:id

Exempelanrop

{
  "name": "Daily backup (updated)",
  "period": 43200,
  "grace": 1800,
  "state": "PAUSED",
  "alerts": ["alert-id-1"],
  "onFail": {
    "notifySubscribers": false
  }
}

Exempelsvar

{
  "cronMonitor": {
    "id": "cron-abc123",
    "name": "Daily backup (updated)",
    "slug": "my-page-x7k2m9n4p1q8w3e5",
    "period": 43200,
    "grace": 1800,
    "status": "UP",
    "state": "PAUSED",
    "siteId": "page123",
    "order": 1,
    "groupId": null,
    "componentId": "component-id-1",
    "onFailCreateIncident": true,
    "onFailCreateOutageDuration": false,
    "onFailPublishIncident": true,
    "onFailNotifySubscribers": false,
    "onRecoverResolveIncident": true,
    "onRecoverResolveOutageDuration": false,
    "onRecoverPublishIncident": true,
    "onRecoverNotifySubscribers": true,
    "createTemplateId": null,
    "resolveTemplateId": null,
    "alerts": [
      {
        "id": "alert-id-1",
        "type": "EMAIL",
        "recipient": "ops@example.com"
      }
    ],
    "createdAt": "2024-01-15T08:00:00.000Z",
    "updatedAt": "2024-01-16T10:30:00.000Z"
  },
  "message": "Cron monitor updated successfully."
}

Radera en cron-övervakare

Endpoint:

DELETE /monitors/cron/:id

Exempelanrop

DELETE /monitors/cron/cron-abc123

Exempelsvar

{
  "cronMonitor": {
    "id": "cron-abc123",
    "name": "Daily backup",
    "slug": "my-page-x7k2m9n4p1q8w3e5",
    "period": 86400,
    "grace": 3600,
    "status": "UP",
    "state": "ACTIVE",
    "siteId": "page123",
    "order": 1,
    "groupId": null,
    "componentId": "component-id-1",
    "onFailCreateIncident": true,
    "onFailCreateOutageDuration": false,
    "onFailPublishIncident": true,
    "onFailNotifySubscribers": true,
    "onRecoverResolveIncident": true,
    "onRecoverResolveOutageDuration": false,
    "onRecoverPublishIncident": true,
    "onRecoverNotifySubscribers": true,
    "createTemplateId": null,
    "resolveTemplateId": null,
    "createdAt": "2024-01-15T08:00:00.000Z",
    "updatedAt": "2024-01-15T08:00:00.000Z"
  },
  "message": "Cron monitor deleted successfully."
}

Hämta loggar för en cron-övervakare

Endpoint:

GET /monitors/cron/:id/logs

Query-parametrar

Parameter	Typ	Standardvärde	Beskrivning
`limit`	`number`	`100`	Antal loggar per sida. Max är 127.
`page`	`number`	`1`	Sidnumret. Max är 1000.
`startDate`	`string`	1 år sedan	Startdatum enligt ISO 8601 för loggintervallet.
`endDate`	`string`	nu	Slutdatum enligt ISO 8601 för loggintervallet.
`importance`	`enum`	`null`	Filtrera loggar efter vikt ('all', 'important').

Exempelanrop

GET /monitors/cron/cron-abc123/logs?limit=50&page=1&importance=important

Exempelsvar

{
  "logs": [
    {
      "id": "log-xyz789",
      "monitorId": "cron-abc123",
      "status": "SUCCESS",
      "requestType": "GET",
      "agent": "curl/8.4.0",
      "ipAddress": "203.0.113.10",
      "createdAt": "2024-01-16T06:00:00.000Z",
      "startedAt": "2024-01-16T05:59:58.000Z"
    }
  ],
  "page": 1
}

Hämta sammanfattning för en cron-övervakare

Endpoint:

GET /monitors/cron/:id/summary

Exempelanrop

GET /monitors/cron/cron-abc123/summary

Exempelsvar

{
  "summary": {
    "totalLogs": 120,
    "totalFailedLogs": 3,
    "availability": 97.5,
    "oneDayAvailability": 100,
    "previousDayAvailability": 100,
    "sevenDayAvailability": 98.2,
    "previousSevenDayAvailability": 96.1,
    "thirtyDayAvailability": 97.5,
    "previousThirtyDayAvailability": 95.8,
    "lastSuccess": "2024-01-16T06:00:00.000Z",
    "lastFailure": "2024-01-10T06:00:00.000Z",
    "lastStarted": null,
    "upSince": "2024-01-10T07:00:00.000Z",
    "downSince": null
  }
}

Ping-endpoints

De här endpointerna kräver inte autentisering. Övervakarens slug fungerar som hemlighet.

Du kan pinga via API:ets bas-URL eller via den dedikerade cron-värden:

Lyckat: https://cron.instatus.com/{slug} eller GET / POST / HEAD /monitors/cron/{slug}
Fel: https://cron.instatus.com/{slug}/fail eller GET / POST / HEAD /monitors/cron/{slug}/fail
Start: https://cron.instatus.com/{slug}/start eller GET / POST / HEAD /monitors/cron/{slug}/start

Skicka en lyckad-ping varje gång jobbet blir klart enligt schemat. Skicka en startping innan jobbet körs och en lyckad- eller fel-ping när det är klart för att registrera körtiden.

Exempel på lyckad ping

curl https://cron.instatus.com/my-page-x7k2m9n4p1q8w3e5

Exempelsvar

{
  "id": "log-xyz789",
  "monitorId": "cron-abc123",
  "status": "SUCCESS",
  "requestType": "GET",
  "agent": "curl/8.4.0",
  "ipAddress": "203.0.113.10",
  "createdAt": "2024-01-16T06:00:00.000Z"
}

Om sluggen är ogiltig blir svaret:

{
  "message": "Monitor not found"
}