openapi: 3.1.2 jsonSchemaDialect: https://spec.openapis.org/oas/3.1/dialect/base # schema: # $ref: ./oh-dear-schema.json info: title: Oh Dear API version: "1.0.0" license: name: MIT url: https://opensource.org/licenses/MIT summary: Oh Dear API contact: email: support@ohdear.app name: Oh Dear Support url: https://ohdear.app description: > OpenAPI 3.1 specification for the Oh Dear API, aligned with the public documentation and SDK. Authentication is via the HTTP Authorization Header using a Bearer token. Requests for a resource you are not allowed to access return 404 Not Found, exactly like a resource that does not exist. servers: - url: https://ohdear.app/api description: Production security: - bearerAuth: [] tags: - name: AI description: Endpoints related to AI monitoring responses. - name: Application Health Checks description: Endpoints related to application health checks. - name: Broken Links description: Endpoints related to broken links checks. - name: Crawled URLs description: Endpoints for retrieving crawled URL summaries and details from broken links crawl runs. - name: Certificates description: Endpoints related to certificate health checks. - name: Check History description: Endpoints for listing historical check runs and fetching results from specific past runs. - name: Checks description: Endpoints for managing checks on monitors. - name: Cron Checks description: Endpoints related to cron checks. - name: Current User description: Endpoints related to the current authenticated user. - name: Detected Certificates description: Endpoints related to detected certificates. - name: DNS description: Endpoints related to DNS records and history. - name: DNS Blocklist description: Endpoints related to DNS blocklist monitoring. - name: Domain description: Endpoints related to domain registration information. - name: Downtime description: Endpoints related to downtime periods. - name: Lighthouse description: Endpoints related to Lighthouse performance reports. - name: Maintenance Periods description: Endpoints related to maintenance periods. - name: Me description: Endpoints related to the current authenticated user. - name: Mixed Content description: Endpoints related to mixed content checks. - name: Monitors description: Endpoints for managing monitors. - name: Notification Destinations description: Endpoints for managing notification destinations for teams, monitors, tags, and tag groups. - name: Ports description: Endpoints related to port scanning monitoring. - name: Public Metrics description: Endpoints for public API metrics (no auth required). - name: Recurring Maintenance Periods description: Endpoints for managing recurring maintenance periods. - name: Reseller description: Endpoints for resellers to manage teams and users for their clients. - name: Sitemap description: Endpoints related to sitemap monitoring. - name: Status Page Update Templates description: Endpoints for managing status page update templates. - name: Status Page Updates description: Endpoints related to status page updates. - name: Status Pages description: Endpoints related to status pages. - name: Tag Groups description: Endpoints for managing tag groups. - name: Tags description: Endpoints for managing tags. - name: Uptime description: Endpoints related to uptime. - name: Uptime Metrics description: Endpoints related to uptime metrics. paths: /me: get: tags: [Me, Current User] summary: Get current user description: Returns the user and team info for the authenticated user. This endpoint can be used to retrieve information about the current user. operationId: getMe responses: "200": description: User info content: application/json: schema: $ref: "#/components/schemas/User" "401": $ref: "#/components/responses/Unauthorized" "403": $ref: "#/components/responses/Forbidden" /monitors: get: tags: [Monitors] summary: List monitors description: Returns a paginated list of monitors for the authenticated user's team. operationId: listMonitors parameters: - $ref: "#/components/parameters/PageNumber" - $ref: "#/components/parameters/PageSize" responses: "200": description: Paginated monitors content: application/json: schema: $ref: "#/components/schemas/PaginatedMonitors" examples: success: value: data: - id: 99 team_id: 1 type: http url: https://example.com uses_https: true sort_url: example.com label: example.com group_name: "" tags: [] description: null notes: null latest_run_date: "2019-09-16 07:29:02" summarized_check_result: succeeded checks: - id: 100 type: uptime label: Uptime enabled: true latest_run_ended_at: "2019-09-16 07:29:02" latest_run_result: succeeded summary: Up settings: uptime_check_settings: uptime_check_location: paris active_snooze: null uptime_check_settings: location: paris look_for_string: "" absent_string: null expected_response_headers: [] response_body_assertions: [] failed_notification_threshold: 2 http_verb: get payload: [] raw_payload: null timeout: 5 valid_status_codes: ["2*"] max_redirect_count: 5 expected_final_redirect_url: null http_client_headers: [] badge_id: badge-123 marked_for_deletion_at: null created_at: "2019-09-16 07:25:00" updated_at: "2019-09-16 07:25:00" links: first: https://ohdear.app/api/monitors?page%5Bnumber%5D=1 last: https://ohdear.app/api/monitors?page%5Bnumber%5D=5 prev: null next: https://ohdear.app/api/monitors?page%5Bnumber%5D=2 meta: current_page: 1 from: 1 last_page: 5 path: https://ohdear.app/api/monitors per_page: 100 to: 100 total: 500 "401": { $ref: "#/components/responses/Unauthorized" } "403": { $ref: "#/components/responses/Forbidden" } post: tags: [Monitors] summary: Create a monitor description: Create a new monitor for the authenticated user's team. operationId: createMonitor requestBody: description: The payload to include with the request. required: true content: application/json: schema: $ref: "#/components/schemas/CreateMonitorRequest" examples: minimal: value: url: https://example.com team_id: 1 type: http withChecksAndSettings: value: url: https://ohdear.app/docs type: http team_id: 1 checks: [ uptime, performance, broken_links, mixed_content, lighthouse, cron, application_health, sitemap, dns, domain, certificate_health, ] group_name: Internal friendly_name: Documentation tags: [internal, production, docs] notes: Internal notes for our team members description: Oh Dear documentation uptime_check_settings: location: paris expected_final_redirect_url: https://redirect-to-this-url.com failed_notification_threshold: 2 http_verb: get timeout: 5 max_redirect_count: 5 payload: - name: payload-name-1 value: payload-value-1 raw_payload: null valid_status_codes: ["2*"] look_for_string: null absent_string: null expected_response_headers: - name: my-response-header condition: equals value: my-response-value response_body_assertions: - path: data.status operator: equals value: ok http_client_headers: - name: my-header value: my-value performance_check_settings: threshold_in_ms: 3500 change_percentage: 50 crawler_settings: headers: - name: my-broken-links-header value: my-broken-links-value respect_robots: true broken_links_check_settings: check_include_external_links: false types: [link, image, script, stylesheet, "og:image"] whitelisted_urls: [] sitemap_check_settings: path: /sitemap.xml speed: slow application_health_check_settings: result_url: https://mybrandnewsite.tld/health frequency_value: 360 frequency_unit: minute headers: - name: my-header value: my-value certificate_health_check_settings: expires_soon_threshold_in_days: 14 dns_check_settings: check_nameservers_in_sync: true monitor_main_domain: false extra_cnames: [cname1, cname2] ignored_record_types: [A, CNAME] domain_check_settings: expires_soon_threshold_in_days: 30 lighthouse_check_settings: continent: europe send_report_to_emails: ["a@example.com", "b@example.com"] include_check_types_in_report: [ uptime, performance, broken_links, mixed_content, lighthouse, cron, application_health, sitemap, dns, domain, certificate_health, ] responses: "201": description: Monitor created content: application/json: schema: $ref: "#/components/schemas/Monitor" examples: created: value: id: 173 team_id: 1 type: http url: https://example.com uses_https: true sort_url: example.com label: example.com group_name: "" tags: [] description: null notes: null latest_run_date: null summarized_check_result: pending checks: - id: 560 type: uptime label: Uptime enabled: true latest_run_ended_at: null latest_run_result: pending summary: Pending settings: uptime_check_settings: uptime_check_location: paris active_snooze: null - id: 561 type: certificate_health label: Certificate health enabled: true latest_run_ended_at: null latest_run_result: pending summary: Pending settings: certificate_health_check_settings: expires_soon_threshold_in_days: null active_snooze: null uptime_check_settings: location: paris look_for_string: "" absent_string: null expected_response_headers: [] response_body_assertions: [] failed_notification_threshold: 2 http_verb: get payload: [] raw_payload: null timeout: 5 valid_status_codes: ["2*"] max_redirect_count: 5 expected_final_redirect_url: null http_client_headers: [] badge_id: badge-abc123 marked_for_deletion_at: null created_at: "2019-09-16 08:00:00" updated_at: "2019-09-16 08:00:00" "401": { $ref: "#/components/responses/Unauthorized" } "403": { $ref: "#/components/responses/Forbidden" } "422": { $ref: "#/components/responses/Validation" } /monitors/{monitorId}: get: tags: [Monitors] summary: Get a monitor description: Retrieve detailed information about a specific monitor by its ID. operationId: getMonitor parameters: - $ref: "#/components/parameters/MonitorId" responses: "200": description: Monitor content: application/json: schema: $ref: "#/components/schemas/Monitor" examples: success: value: id: 99 team_id: 1 type: http url: https://example.com uses_https: true sort_url: example.com label: example.com group_name: "" tags: [] description: null notes: null latest_run_date: "2019-09-16 07:29:02" summarized_check_result: succeeded checks: - id: 100 type: uptime label: Uptime enabled: true latest_run_ended_at: "2019-09-16 07:29:02" latest_run_result: succeeded summary: Up settings: uptime_check_settings: uptime_check_location: paris active_snooze: null uptime_check_settings: location: paris look_for_string: "" absent_string: null expected_response_headers: [] response_body_assertions: [] failed_notification_threshold: 2 http_verb: get payload: [] raw_payload: null timeout: 5 valid_status_codes: ["2*"] max_redirect_count: 5 expected_final_redirect_url: null http_client_headers: [] badge_id: badge-123 marked_for_deletion_at: null created_at: "2019-09-16 07:25:00" updated_at: "2019-09-16 07:25:00" "401": { $ref: "#/components/responses/Unauthorized" } "404": { $ref: "#/components/responses/NotFound" } put: tags: [Monitors] summary: Update a monitor description: Update the settings of an existing monitor. operationId: updateMonitor parameters: - $ref: "#/components/parameters/MonitorId" requestBody: description: The payload to update the monitor with. required: true content: application/json: schema: $ref: "#/components/schemas/UpdateMonitorRequest" examples: example: value: url: https://example.com/docs checks: [ uptime, performance, broken_links, mixed_content, lighthouse, cron, application_health, sitemap, dns, domain, certificate_health, ] group_name: Internal friendly_name: Documentation tags: [internal, production, docs] notes: Internal notes for our team members description: Documentation site monitoring uptime_check_settings: location: paris expected_final_redirect_url: https://redirect-to-this-url.com failed_notification_threshold: 2 http_verb: get timeout: 5 max_redirect_count: 5 payload: - name: payload-name-1 value: payload-value-1 valid_status_codes: ["2*"] look_for_string: null absent_string: null expected_response_headers: - name: my-response-header condition: equals value: my-response-value response_body_assertions: - path: data.status operator: equals value: ok http_client_headers: - name: my-header value: my-value performance_check_settings: threshold_in_ms: 3500 change_percentage: 50 broken_links_check_settings: check_include_external_links: false types: [link, image, script, stylesheet, "og:image"] whitelisted_urls: [] crawler_settings: respect_robots: true sitemap_check_settings: path: /sitemap.xml speed: slow application_health_check_settings: result_url: https://example.com/health secret: my-health-check-secret frequency_value: 360 frequency_unit: minute headers: - name: my-header value: my-value certificate_health_check_settings: expires_soon_threshold_in_days: 14 dns_check_settings: check_nameservers_in_sync: true monitor_main_domain: false extra_cnames: [cname1, cname2] ignored_record_types: [A, CNAME] domain_check_settings: expires_soon_threshold_in_days: 30 lighthouse_check_settings: continent: europe cpu_slowdown_modifier: 0 crawler_headers: - name: my-broken-links-header value: my-broken-links-value send_report_to_emails: ["a@example.com", "b@example.com"] include_check_types_in_report: [ uptime, performance, broken_links, mixed_content, lighthouse, cron, application_health, sitemap, dns, domain, certificate_health, ] responses: "200": description: Updated monitor content: application/json: schema: $ref: "#/components/schemas/Monitor" examples: success: value: id: 99 label: Documentation "401": { $ref: "#/components/responses/Unauthorized" } "404": { $ref: "#/components/responses/NotFound" } "422": { $ref: "#/components/responses/Validation" } delete: tags: [Monitors] summary: Delete a monitor description: Delete a monitor by its ID. This action is irreversible. operationId: deleteMonitor parameters: - $ref: "#/components/parameters/MonitorId" responses: "204": { $ref: "#/components/responses/NoContent" } "401": { $ref: "#/components/responses/Unauthorized" } "404": { $ref: "#/components/responses/NotFound" } /monitors/{monitorId}/check-summary/{checkType}: get: tags: [Checks] summary: Get summary for a check type on a monitor description: Retrieve a summary of the latest result for a specific check type on a monitor. operationId: getCheckSummary parameters: - $ref: "#/components/parameters/MonitorId" - name: checkType description: The type of check to retrieve the summary for. in: path required: true schema: $ref: "#/components/schemas/CheckType" responses: "200": description: Check summary content: application/json: schema: $ref: "#/components/schemas/CheckSummary" examples: success: value: result: succeeded summary: Up "401": { $ref: "#/components/responses/Unauthorized" } "404": { $ref: "#/components/responses/NotFound" } # --- Check History --- /monitors/{monitorId}/checks/{checkType}/runs: get: tags: [Check History] summary: List historical check runs description: > Returns a paginated list of completed runs for any check type on a monitor. Only runs with a result of `succeeded`, `warning`, or `failed` are included. Runs are kept for approximately 10 days before being automatically pruned. Use the returned run IDs to fetch detailed results from the broken links, mixed content, certificate health, or sitemap endpoints via their `run_id` query parameter. operationId: listCheckRuns parameters: - $ref: "#/components/parameters/MonitorId" - name: checkType description: The type of check to list runs for. in: path required: true schema: $ref: "#/components/schemas/CheckType" - $ref: "#/components/parameters/FilterStartedAfter" - $ref: "#/components/parameters/FilterStartedBefore" - $ref: "#/components/parameters/FilterResult" - $ref: "#/components/parameters/PageNumber" - $ref: "#/components/parameters/PageSize" responses: "200": description: Paginated list of check runs content: application/json: schema: $ref: "#/components/schemas/CheckRunsResponse" examples: success: value: data: - id: 98765 check_id: 30536 check_type: broken_links result: succeeded started_at: "2026-03-17T00:30:00+00:00" ended_at: "2026-03-17T00:53:58+00:00" ohdear_url: "https://ohdear.app/monitors/1234/check/broken-links/report/98765" - id: 98710 check_id: 30536 check_type: broken_links result: failed started_at: "2026-03-16T00:30:00+00:00" ended_at: "2026-03-16T00:48:12+00:00" ohdear_url: "https://ohdear.app/monitors/1234/check/broken-links/report/98710" links: documentation_url: "https://ohdear.app/docs/features/broken-links-detection" "...": "..." meta: "...": "..." "401": { $ref: "#/components/responses/Unauthorized" } "404": { $ref: "#/components/responses/NotFound" } "422": { $ref: "#/components/responses/Validation" } /checks/{checkId}/enable: post: tags: [Checks] summary: Enable a check description: Enable a specific check by its ID. A `performance` check can't be enabled directly; enable the `uptime` check instead. operationId: enableCheck parameters: - $ref: "#/components/parameters/CheckId" responses: "200": description: Enabled content: application/json: schema: $ref: "#/components/schemas/CheckEnableToggle" examples: success: value: { id: 405, type: uptime, enabled: true } "401": { $ref: "#/components/responses/Unauthorized" } "404": { $ref: "#/components/responses/NotFound" } "422": description: >- The check is a `performance` check, which can't be enabled directly. It follows the `uptime` check, so enable that check instead. content: application/json: schema: $ref: "#/components/schemas/Error" examples: performance_check: value: message: You cannot enable or disable performance checks directly. Instead enable or disable the uptime check for this site. /checks/{checkId}/disable: post: tags: [Checks] summary: Disable a check description: Disable a specific check by its ID. A `performance` check can't be disabled directly; disable the `uptime` check instead. operationId: disableCheck parameters: - $ref: "#/components/parameters/CheckId" responses: "200": description: Disabled content: application/json: schema: $ref: "#/components/schemas/CheckEnableToggle" examples: success: value: { id: 405, type: uptime, enabled: false } "401": { $ref: "#/components/responses/Unauthorized" } "404": { $ref: "#/components/responses/NotFound" } "422": description: >- The check is a `performance` check, which can't be disabled directly. It follows the `uptime` check, so disable that check instead. content: application/json: schema: $ref: "#/components/schemas/Error" examples: performance_check: value: message: You cannot enable or disable performance checks directly. Instead enable or disable the uptime check for this site. /checks/{checkId}/request-run: post: tags: [Checks] summary: Request an immediate run of a check description: Request an immediate run of a specific check. Optionally, custom HTTP headers can be provided for HTTP-based checks. operationId: requestCheckRun parameters: - $ref: "#/components/parameters/CheckId" requestBody: description: The optional payload to include with the request. required: false content: application/json: schema: $ref: "#/components/schemas/CheckRunRequest" examples: withHeaders: value: httpClientHeaders: - name: X-Custom-Header value: custom-value responses: "200": description: Check details after run request accepted content: application/json: schema: $ref: "#/components/schemas/Check" examples: success: value: id: 1 type: mixed_content label: Mixed content enabled: true latest_run_ended_at: "2019-09-16 07:29:05" latest_run_result: succeeded settings: {} active_snooze: null "401": { $ref: "#/components/responses/Unauthorized" } "403": { $ref: "#/components/responses/Forbidden" } "404": { $ref: "#/components/responses/NotFound" } /checks/{checkId}/snooze: post: tags: [Checks] summary: Snooze notifications for a check description: Snooze notifications for a specific check for a given duration in minutes. operationId: snoozeCheck parameters: - $ref: "#/components/parameters/CheckId" requestBody: description: The payload to include with the request. required: true content: application/json: schema: type: object required: [minutes] properties: minutes: type: string description: Duration in minutes (string) examples: example: value: { minutes: "10" } responses: "200": description: Snooze applied content: application/json: schema: $ref: "#/components/schemas/Check" "401": { $ref: "#/components/responses/Unauthorized" } "404": { $ref: "#/components/responses/NotFound" } /checks/{checkId}/unsnooze: post: tags: [Checks] summary: Remove snooze from a check description: Remove any active snooze from a specific check. operationId: unsnoozeCheck parameters: - $ref: "#/components/parameters/CheckId" responses: "200": description: Unsnoozed content: application/json: schema: $ref: "#/components/schemas/Check" "401": { $ref: "#/components/responses/Unauthorized" } "404": { $ref: "#/components/responses/NotFound" } /cron-checks/{cronCheckId}/snooze: post: tags: [Cron Checks] summary: Snooze a cron check description: Snooze notifications for a specific cron check for a given duration in minutes. operationId: snoozeCronCheck parameters: - $ref: "#/components/parameters/CronCheckId" requestBody: description: The payload to include with the request. required: true content: application/json: schema: type: object required: [minutes] properties: minutes: type: string examples: example: value: { minutes: "10" } responses: "200": description: Snoozed content: application/json: schema: $ref: "#/components/schemas/CronCheck" "401": { $ref: "#/components/responses/Unauthorized" } "404": { $ref: "#/components/responses/NotFound" } /cron-checks/{cronCheckId}/unsnooze: post: tags: [Cron Checks] summary: Unsnooze a cron check description: Remove any active snooze from a specific cron check. operationId: unsnoozeCronCheck parameters: - $ref: "#/components/parameters/CronCheckId" responses: "200": description: Unsnoozed content: application/json: schema: $ref: "#/components/schemas/CronCheck" "401": { $ref: "#/components/responses/Unauthorized" } "404": { $ref: "#/components/responses/NotFound" } /monitors/{monitorId}/application-health-checks: get: tags: [Application Health Checks] summary: List application health checks for a monitor description: Retrieve a list of application health checks associated with a specific monitor. operationId: listApplicationHealthChecks parameters: - $ref: "#/components/parameters/MonitorId" responses: "200": description: Health checks content: application/json: schema: type: object properties: data: type: array items: $ref: "#/components/schemas/ApplicationHealthCheck" examples: success: value: data: - id: 42 name: queue latest_result: succeeded latest_run_ended_at: "2024-11-10 12:00:00" "401": { $ref: "#/components/responses/Unauthorized" } "404": { $ref: "#/components/responses/NotFound" } /monitors/{monitorId}/application-health-checks/{applicationHealthCheckId}/snooze: post: tags: [Application Health Checks] summary: Snooze an application health check description: Snooze notifications for a specific application health check for a given duration in minutes. operationId: snoozeApplicationHealthCheck parameters: - $ref: "#/components/parameters/MonitorId" - $ref: "#/components/parameters/ApplicationHealthCheckId" requestBody: description: The payload to include with the request. required: true content: application/json: schema: type: object required: [minutes] properties: minutes: type: string examples: example: value: { minutes: "10" } responses: "200": description: Snoozed content: application/json: schema: $ref: "#/components/schemas/ApplicationHealthCheck" "401": { $ref: "#/components/responses/Unauthorized" } "404": { $ref: "#/components/responses/NotFound" } /monitors/{monitorId}/application-health-checks/{applicationHealthCheckId}/unsnooze: post: tags: [Application Health Checks] summary: Unsnooze an application health check description: Remove any active snooze from a specific application health check. operationId: unsnoozeApplicationHealthCheck parameters: - $ref: "#/components/parameters/MonitorId" - $ref: "#/components/parameters/ApplicationHealthCheckId" responses: "200": description: Unsnoozed content: application/json: schema: $ref: "#/components/schemas/ApplicationHealthCheck" "401": { $ref: "#/components/responses/Unauthorized" } "404": { $ref: "#/components/responses/NotFound" } /monitors/{monitorId}/uptime: get: tags: [Uptime] summary: Uptime percentages for a monitor description: Retrieve uptime percentages for a specific monitor over a defined period, with optional granularity. operationId: getUptime parameters: - $ref: "#/components/parameters/MonitorId" - $ref: "#/components/parameters/FilterStartedAt" - $ref: "#/components/parameters/FilterEndedAt" - name: split in: query description: Granularity of the periods schema: type: string enum: [hour, day, month] responses: "200": description: Uptime series content: application/json: schema: type: array items: $ref: "#/components/schemas/UptimePoint" examples: success: value: - datetime: "2018-01-01 00:00:00" uptime_percentage: 100 - datetime: "2018-01-01 01:00:00" uptime_percentage: 99.76 "401": { $ref: "#/components/responses/Unauthorized" } "404": { $ref: "#/components/responses/NotFound" } /monitors/{monitorId}/downtime: get: tags: [Downtime] summary: Downtime periods for a monitor description: Retrieve a list of downtime periods for a specific monitor within a defined time range. operationId: getDowntime parameters: - $ref: "#/components/parameters/MonitorId" - $ref: "#/components/parameters/FilterStartedAt" - $ref: "#/components/parameters/FilterEndedAt" responses: "200": description: Downtime periods content: application/json: schema: $ref: "#/components/schemas/PaginatedDowntime" examples: success: value: data: - id: 1 started_at: "2018-01-01 15:00:00" ended_at: "2018-01-01 15:07:00" notes_html: "We contacted our provider and they fixed the issue." notes_markdown: "We contacted our provider and they fixed the issue." "401": { $ref: "#/components/responses/Unauthorized" } "404": { $ref: "#/components/responses/NotFound" } /downtime/{downtimeId}: delete: tags: [Downtime] summary: Delete a downtime period description: Delete a specific downtime period by its ID. This action is irreversible. operationId: deleteDowntime parameters: - name: downtimeId description: The ID of the downtime period to delete. in: path required: true schema: { type: integer } responses: "204": { $ref: "#/components/responses/NoContent" } "401": { $ref: "#/components/responses/Unauthorized" } "404": { $ref: "#/components/responses/NotFound" } /monitors/{monitorId}/http-uptime-metrics: get: tags: [Uptime Metrics] summary: HTTP uptime metrics description: Retrieve HTTP uptime metrics for a specific monitor over a defined period. operationId: httpUptimeMetrics parameters: - $ref: "#/components/parameters/MonitorId" - $ref: "#/components/parameters/FilterStart" - $ref: "#/components/parameters/FilterEnd" - $ref: "#/components/parameters/FilterGroupBy" responses: "200": description: Metrics series content: application/json: schema: $ref: "#/components/schemas/UptimeMetricsHttpResponse" examples: success: value: data: - dns_time_in_seconds: 0.001399 tcp_time_in_seconds: 0.01651 ssl_handshake_time_in_seconds: 0.053852 remote_server_processing_time_in_seconds: 0.021595 download_time_in_seconds: 0.000535 total_time_in_seconds: 0.093891 curl: namelookup_time: 0.001399 connect_time: 0.017909 appconnect_time: 0.071761 starttransfer_time: 0.093356 pretransfer_time: 0.071864 redirect_time: 0 total_time: 0.093891 header_size: 1261 size_download: 12814 speed_download: 137784 date: "2024-04-19 13:25:00" "401": { $ref: "#/components/responses/Unauthorized" } "404": { $ref: "#/components/responses/NotFound" } /monitors/{monitorId}/ping-uptime-metrics: get: tags: [Uptime Metrics] summary: Ping uptime metrics description: Retrieve ping uptime metrics for a specific monitor over a defined period. operationId: pingUptimeMetrics parameters: - $ref: "#/components/parameters/MonitorId" - $ref: "#/components/parameters/FilterStart" - $ref: "#/components/parameters/FilterEnd" - $ref: "#/components/parameters/FilterGroupBy" responses: "200": description: Metrics series content: application/json: schema: $ref: "#/components/schemas/UptimeMetricsPingResponse" examples: success: value: data: - minimum_time_in_ms: 12.5 maximum_time_in_ms: 45.2 average_time_in_ms: 28.7 packet_loss_percentage: 0.0 uptime_percentage: 100.0 downtime_percentage: 0.0 uptime_seconds: 60 downtime_seconds: 0 date: "2024-04-19 13:25:00" "401": { $ref: "#/components/responses/Unauthorized" } "404": { $ref: "#/components/responses/NotFound" } /monitors/{monitorId}/tcp-uptime-metrics: get: tags: [Uptime Metrics] summary: TCP uptime metrics description: Retrieve TCP uptime metrics for a specific monitor over a defined period. operationId: tcpUptimeMetrics parameters: - $ref: "#/components/parameters/MonitorId" - $ref: "#/components/parameters/FilterStart" - $ref: "#/components/parameters/FilterEnd" - $ref: "#/components/parameters/FilterGroupBy" responses: "200": description: Metrics series content: application/json: schema: $ref: "#/components/schemas/UptimeMetricsTcpResponse" examples: success: value: data: - time_to_connect_in_ms: 15.3 uptime_percentage: 100.0 downtime_percentage: 0.0 uptime_seconds: 60 downtime_seconds: 0 date: "2024-04-19 13:25:00" "401": { $ref: "#/components/responses/Unauthorized" } "404": { $ref: "#/components/responses/NotFound" } /broken-links/{monitorId}: get: tags: [Broken Links] summary: Get broken links for a monitor description: > Retrieve a list of broken links found by the broken links check for a specific monitor. Returns results from the latest completed crawl run by default. Pass `run_id` to fetch results from a specific past run (see check history endpoint). operationId: listBrokenLinks parameters: - $ref: "#/components/parameters/MonitorId" - $ref: "#/components/parameters/RunId" responses: "200": description: Broken links content: application/json: schema: $ref: "#/components/schemas/BrokenLinksResponse" examples: success: value: data: - status_code: 404 crawled_url: https://example.com/broken relative_crawled_url: /broken found_on_url: https://example.com relative_found_on_url: / link_text: Click here type: link error_message: null internal: true meta: run_id: 98765 run_started_at: "2026-03-17T00:30:00+00:00" run_ended_at: "2026-03-17T00:53:58+00:00" ohdear_url: "https://ohdear.app/monitors/1234/check/broken-links/report/98765" links: documentation_url: "https://ohdear.app/docs/features/broken-links-detection" "401": { $ref: "#/components/responses/Unauthorized" } "404": { $ref: "#/components/responses/NotFound" } /monitors/{monitorId}/add-to-broken-links-whitelist: post: tags: [Broken Links] summary: Add a URL to the broken links whitelist description: Add a URL to the broken links whitelist for a specific monitor. The URL will be ignored in future broken links checks. operationId: addBrokenLinksWhitelistUrl parameters: - $ref: "#/components/parameters/MonitorId" requestBody: description: The payload to include with the request. required: true content: application/json: schema: type: object required: [whitelistUrl] properties: whitelistUrl: type: string format: uri examples: example: value: { whitelistUrl: "https://externalsite.tld/page1" } responses: "200": description: Whitelist updated content: application/json: schema: type: object properties: message: { type: string } examples: success: value: { message: "URL added to whitelist." } "401": { $ref: "#/components/responses/Unauthorized" } "404": { $ref: "#/components/responses/NotFound" } /crawled-urls/{monitorId}/summary: get: tags: [Crawled URLs] summary: Get crawled URLs summary description: > Returns a summary with counts of all URLs found during a crawl run, not just the broken ones. Useful for understanding the scope of a crawl without fetching every URL. Returns results from the latest completed crawl run by default. Pass `run_id` to fetch results from a specific past run (see check history endpoint). operationId: getCrawledUrlsSummary parameters: - $ref: "#/components/parameters/MonitorId" - $ref: "#/components/parameters/RunId" responses: "200": description: Crawled URLs summary content: application/json: schema: $ref: "#/components/schemas/CrawledUrlsSummaryResponse" examples: success: value: data: total: 1234 internal: 800 external: 434 by_type: image: 250 link: 900 og:image: 14 script: 40 stylesheet: 30 meta: run_id: 98765 run_started_at: "2026-03-17T00:30:00+00:00" run_ended_at: "2026-03-17T00:53:58+00:00" links: {} "401": { $ref: "#/components/responses/Unauthorized" } "404": { $ref: "#/components/responses/NotFound" } "422": description: Monitor has no broken links check content: application/json: schema: $ref: "#/components/schemas/Error" /crawled-urls/{monitorId}/details: get: tags: [Crawled URLs] summary: Get crawled URLs details description: > Returns a paginated list of all URLs found during a crawl run (100 per page). Each entry includes the same fields as the broken links response. Returns results from the latest completed crawl run by default. Pass `run_id` to fetch results from a specific past run (see check history endpoint). operationId: listCrawledUrlsDetails parameters: - $ref: "#/components/parameters/MonitorId" - $ref: "#/components/parameters/RunId" - $ref: "#/components/parameters/Page" responses: "200": description: Paginated crawled URLs content: application/json: schema: $ref: "#/components/schemas/CrawledUrlsDetailsResponse" examples: success: value: data: - status_code: 200 crawled_url: https://example.com/page relative_crawled_url: /page found_on_url: https://example.com relative_found_on_url: / link_text: Some page type: link error_message: null internal: true meta: current_page: 1 from: 1 last_page: 53 per_page: 100 to: 100 total: 5230 run_id: 98765 run_started_at: "2026-03-17T00:30:00+00:00" run_ended_at: "2026-03-17T00:53:58+00:00" links: first: "/?page=1" last: "/?page=53" prev: null next: "/?page=2" "401": { $ref: "#/components/responses/Unauthorized" } "404": { $ref: "#/components/responses/NotFound" } "422": description: Monitor has no broken links check content: application/json: schema: $ref: "#/components/schemas/Error" /mixed-content/{monitorId}: get: tags: [Mixed Content] summary: Get mixed content results for a monitor description: > Retrieve a list of mixed content items found by the mixed content check for a specific monitor. Returns results from the latest completed crawl run by default. Pass `run_id` to fetch results from a specific past run (see check history endpoint). operationId: listMixedContent parameters: - $ref: "#/components/parameters/MonitorId" - $ref: "#/components/parameters/RunId" responses: "200": description: Mixed content items content: application/json: schema: $ref: "#/components/schemas/MixedContentResponse" examples: success: value: data: - element_name: img mixed_content_url: http://example.com/image.jpg found_on_url: https://example.com meta: run_id: 98765 run_started_at: "2026-03-17T00:30:00+00:00" run_ended_at: "2026-03-17T00:53:58+00:00" ohdear_url: "https://ohdear.app/monitors/1234/check/mixed-content/report/98765" links: documentation_url: "https://ohdear.app/docs/features/mixed-content-detection" "401": { $ref: "#/components/responses/Unauthorized" } "404": { $ref: "#/components/responses/NotFound" } /certificate-health/{monitorId}: get: tags: [Certificates] summary: Get certificate health for a monitor description: > Retrieve the certificate health details for a specific monitor. Returns results from the latest completed run by default. Pass `run_id` to fetch results from a specific past run (see check history endpoint). operationId: getCertificateHealth parameters: - $ref: "#/components/parameters/MonitorId" - $ref: "#/components/parameters/RunId" responses: "200": description: Certificate health content: application/json: schema: $ref: "#/components/schemas/CertificateHealth" examples: success: value: certificate_details: issuer: "Let's Encrypt Authority X3" valid_from: "2019-09-10 15:16:01" valid_until: "2019-12-09 15:16:01" certificate_checks: - type: notFound label: Certificate present passed: true - type: expiresSoon label: Will not expire in the next 14 days passed: true certificate_chain_issuers: - "US, Let's Encrypt, Let's Encrypt Authority X3" - "Digital Signature Trust Co., DST Root CA X3" run_id: 98765 run_started_at: "2026-03-17T00:30:00+00:00" run_ended_at: "2026-03-17T00:53:58+00:00" ohdear_url: "https://ohdear.app/monitors/1234/check/certificate-health/report/98765" documentation_url: "https://ohdear.app/docs/features/certificate-health-monitoring" "401": { $ref: "#/components/responses/Unauthorized" } "404": { $ref: "#/components/responses/NotFound" } /monitors/{monitorId}/detected-certificates: get: tags: [Detected Certificates] summary: List detected certificates for a monitor description: Retrieve a paginated list of detected certificates for a specific monitor, with optional filtering and sorting. operationId: listDetectedCertificates parameters: - $ref: "#/components/parameters/MonitorId" - $ref: "#/components/parameters/PageNumber" - $ref: "#/components/parameters/PageSize" - name: filter[fingerprint] in: query schema: type: string description: Filter by certificate fingerprint - name: sort in: query schema: type: string description: Sort by created_at, updated_at, or fingerprint. Prefix with - for desc. responses: "200": description: Paginated detected certificates content: application/json: schema: $ref: "#/components/schemas/PaginatedDetectedCertificates" examples: success: value: data: - id: 123 monitor_id: 1 fingerprint: abcd1234567890abcd1234567890abcd12345678 certificate_details: issuer: "Let's Encrypt Authority X3" domain: example.com additional_domains: [www.example.com] valid_from: "2023-10-01T12:00:00Z" valid_until: "2024-01-01T12:00:00Z" days_until_expiration: 45 signature_algorithm: sha256WithRSAEncryption is_valid: true is_expired: false created_at: "2023-10-01T12:30:00Z" updated_at: "2023-10-01T12:30:00Z" links: first: https://ohdear.app/api/monitors/1/detected-certificates?page=1 last: https://ohdear.app/api/monitors/1/detected-certificates?page=1 prev: null next: null meta: current_page: 1 from: 1 last_page: 1 per_page: 15 to: 1 total: 1 "401": { $ref: "#/components/responses/Unauthorized" } "404": { $ref: "#/components/responses/NotFound" } /monitors/{monitorId}/detected-certificates/{certificateId}: get: tags: [Detected Certificates] summary: Get a detected certificate description: Retrieve details of a specific detected certificate by its ID for a given monitor. operationId: getDetectedCertificate parameters: - $ref: "#/components/parameters/MonitorId" - name: certificateId description: The ID of the detected certificate to retrieve. in: path required: true schema: { type: integer } responses: "200": description: Detected certificate content: application/json: schema: $ref: "#/components/schemas/DetectedCertificate" examples: success: value: id: 123 monitor_id: 1 fingerprint: abcd1234567890abcd1234567890abcd12345678 certificate_details: issuer: "Let's Encrypt Authority X3" domain: example.com additional_domains: [www.example.com] valid_from: "2023-10-01T12:00:00Z" valid_until: "2024-01-01T12:00:00Z" days_until_expiration: 45 signature_algorithm: sha256WithRSAEncryption is_valid: true is_expired: false created_at: "2023-10-01T12:30:00Z" updated_at: "2023-10-01T12:30:00Z" "401": { $ref: "#/components/responses/Unauthorized" } "404": { $ref: "#/components/responses/NotFound" } /monitors/{monitorId}/maintenance-periods: get: tags: [Maintenance Periods] summary: List maintenance periods for a monitor description: Retrieve a list of maintenance periods associated with a specific monitor. operationId: listMaintenancePeriods parameters: - $ref: "#/components/parameters/MonitorId" - $ref: "#/components/parameters/FilterStartedAt" - $ref: "#/components/parameters/FilterEndedAt" responses: "200": description: Maintenance periods content: application/json: schema: $ref: "#/components/schemas/MaintenancePeriodsResponse" examples: success: value: data: - id: 101 monitor_id: 1 name: Deployment starts_at: "2020-01-09 10:37:24" ends_at: "2020-01-09 10:42:24" "401": { $ref: "#/components/responses/Unauthorized" } "404": { $ref: "#/components/responses/NotFound" } /monitors/{monitorId}/start-maintenance: post: tags: [Maintenance Periods] summary: Start an immediate maintenance period (default 60 minutes) description: Start an immediate maintenance period for a specific monitor. By default, the maintenance period lasts 60 minutes, but you can specify a different duration in seconds. You can also provide an optional name for the maintenance period. operationId: startMaintenance parameters: - $ref: "#/components/parameters/MonitorId" requestBody: description: The optional payload to include with the request. required: false content: application/json: schema: type: object properties: stop_maintenance_after_seconds: type: integer minimum: 5 default: 3600 description: Duration in seconds to auto-stop (minimum 5, default 3600) name: type: string description: Optional name examples: withDuration: value: stop_maintenance_after_seconds: 300 responses: "200": description: Maintenance started content: application/json: schema: $ref: "#/components/schemas/MaintenancePeriod" examples: success: value: id: 101 monitor_id: 1 name: "Optional name of your maintenance period" starts_at: "2020-01-09 10:28:54" ends_at: "2020-01-09 11:28:54" "401": { $ref: "#/components/responses/Unauthorized" } "404": { $ref: "#/components/responses/NotFound" } /monitors/{monitorId}/stop-maintenance: post: tags: [Maintenance Periods] summary: Stop the active maintenance period(s) description: Stop any active maintenance period(s) for a specific monitor. operationId: stopMaintenance parameters: - $ref: "#/components/parameters/MonitorId" requestBody: description: Optional payload to delay the stop required: false content: application/json: schema: type: object properties: delay_seconds: type: integer minimum: 1 description: Number of seconds to delay the stop responses: "204": { $ref: "#/components/responses/NoContent" } "401": { $ref: "#/components/responses/Unauthorized" } "404": { $ref: "#/components/responses/NotFound" } /maintenance-periods: post: tags: [Maintenance Periods] summary: Create a scheduled maintenance period description: Create a scheduled maintenance period for a specific monitor by providing the monitor ID, start time, and end time. operationId: createMaintenancePeriod requestBody: description: The payload to include with the request. required: true content: application/json: schema: $ref: "#/components/schemas/CreateMaintenancePeriodRequest" examples: example: value: monitor_id: "1" starts_at: "2020-02-01 14:00" ends_at: "2020-02-01 18:00" responses: "201": description: Created content: application/json: schema: $ref: "#/components/schemas/MaintenancePeriod" examples: success: value: id: 101 monitor_id: "1" starts_at: "2020-02-01 14:00:00" ends_at: "2020-02-01 18:00:00" "401": { $ref: "#/components/responses/Unauthorized" } "403": { $ref: "#/components/responses/Forbidden" } "422": { $ref: "#/components/responses/Validation" } /maintenance-periods/{maintenancePeriodId}: put: tags: [Maintenance Periods] summary: Update a scheduled maintenance period description: Update an existing scheduled maintenance period by its ID. operationId: updateMaintenancePeriod parameters: - $ref: "#/components/parameters/MaintenancePeriodId" requestBody: required: true content: application/json: schema: $ref: "#/components/schemas/UpdateMaintenancePeriodRequest" responses: "200": description: Maintenance period updated content: application/json: schema: $ref: "#/components/schemas/MaintenancePeriod" "401": { $ref: "#/components/responses/Unauthorized" } "404": { $ref: "#/components/responses/NotFound" } "422": { $ref: "#/components/responses/Validation" } delete: tags: [Maintenance Periods] summary: Delete a maintenance period description: Delete a specific maintenance period by its ID. This action is irreversible. operationId: deleteMaintenancePeriod parameters: - $ref: "#/components/parameters/MaintenancePeriodId" responses: "204": { $ref: "#/components/responses/NoContent" } "401": { $ref: "#/components/responses/Unauthorized" } "404": { $ref: "#/components/responses/NotFound" } /status-pages: get: tags: [Status Pages] summary: List status pages description: Retrieve a paginated list of status pages, with optional pagination parameters. operationId: listStatusPages parameters: - $ref: "#/components/parameters/PageNumber" - $ref: "#/components/parameters/PageSize" responses: "200": description: Paginated status pages content: application/json: schema: $ref: "#/components/schemas/PaginatedStatusPages" examples: success: value: data: - id: 1 team: { id: 1, name: Your Team Name } title: Your Status Page Title domain: status.your-domain.tld slug: autem-quos-... full_url: https://ohdear.app/status-page/autem-quos-... timezone: Europe/Brussels summarized_status: up monitors: - id: 1 url: https://site1.tld created_at: "2019-09-13 07:06:51" updated_at: "2019-09-13 07:06:51" links: first: https://ohdear.app/api/status-pages?page%5Bnumber%5D=1 last: https://ohdear.app/api/status-pages?page%5Bnumber%5D=1 prev: null next: null meta: current_page: 1 from: 1 last_page: 1 path: https://ohdear.app/api/status-pages per_page: 200 to: 2 total: 2 "401": { $ref: "#/components/responses/Unauthorized" } "403": { $ref: "#/components/responses/Forbidden" } post: tags: [Status Pages] summary: Create a status page description: Create a new status page by providing the team ID, title, and associated monitors. Guests of the team cannot create status pages and receive a 404. operationId: createStatusPage requestBody: description: The payload to include with the request. required: true content: application/json: schema: $ref: "#/components/schemas/CreateStatusPageRequest" examples: example: value: team_id: 1 title: My New Status Page monitors: - id: 1 clickable: true - id: 2 clickable: false responses: "201": description: Created content: application/json: schema: $ref: "#/components/schemas/StatusPage" "401": { $ref: "#/components/responses/Unauthorized" } "403": { $ref: "#/components/responses/Forbidden" } "404": { $ref: "#/components/responses/NotFound" } "422": { $ref: "#/components/responses/Validation" } /status-pages/{statusPageId}: get: tags: [Status Pages] summary: Get a status page description: Retrieve details of a specific status page by its ID, including associated monitors and recent updates. operationId: getStatusPage parameters: - $ref: "#/components/parameters/StatusPageId" responses: "200": description: Status page content: application/json: schema: $ref: "#/components/schemas/StatusPageWithUpdates" "401": { $ref: "#/components/responses/Unauthorized" } "404": { $ref: "#/components/responses/NotFound" } delete: tags: [Status Pages] summary: Delete a status page description: Delete a specific status page by its ID. This action is irreversible. operationId: deleteStatusPage parameters: - $ref: "#/components/parameters/StatusPageId" responses: "204": { $ref: "#/components/responses/NoContent" } "401": { $ref: "#/components/responses/Unauthorized" } "404": { $ref: "#/components/responses/NotFound" } /status-pages/{statusPageId}/monitors: post: tags: [Status Pages] summary: Add monitors to a status page description: Add one or more monitors to a specific status page, with an option to synchronize the status page with the current monitor statuses. operationId: addStatusPageMonitors parameters: - $ref: "#/components/parameters/StatusPageId" requestBody: description: The payload to include with the request. required: true content: application/json: schema: $ref: "#/components/schemas/AddStatusPageMonitorsRequest" examples: example: value: sync: true monitors: - id: 17 clickable: true responses: "200": description: Updated content: application/json: schema: $ref: "#/components/schemas/StatusPage" "401": { $ref: "#/components/responses/Unauthorized" } "404": { $ref: "#/components/responses/NotFound" } /status-pages/{statusPageId}/monitors/{monitorId}: delete: tags: [Status Pages] summary: Remove a monitor from a status page description: Remove a specific monitor from a status page by providing the status page ID and monitor ID. operationId: removeStatusPageMonitor parameters: - $ref: "#/components/parameters/StatusPageId" - $ref: "#/components/parameters/MonitorId" responses: "204": { $ref: "#/components/responses/NoContent" } "401": { $ref: "#/components/responses/Unauthorized" } "404": { $ref: "#/components/responses/NotFound" } /status-pages/{statusPageId}/updates: get: tags: [Status Page Updates] summary: List updates for a status page description: Retrieve a list of status page updates for a specific status page by its ID. operationId: listStatusPageUpdates parameters: - $ref: "#/components/parameters/StatusPageId" responses: "200": description: Updates content: application/json: schema: $ref: "#/components/schemas/StatusPageUpdatesResponse" examples: empty: value: { data: [] } success: value: data: - id: 65 title: 3rd party API issue resolved text: We have contacted our API provider and they have resolved the situation, everything is back to normal. We apologize for the inconvenience! pinned: false severity: resolved time: "2019-09-16 08:24:00" status_page_url: https://ohdear.app/status-page/your-slug - id: 64 title: We are experiencing an outage on our service text: Due to errors in our 3rd party API provider, we are experiencing an outage of our website. Our team is working on getting it resolved ASAP. pinned: false severity: high time: "2019-09-16 08:11:00" status_page_url: https://ohdear.app/status-page/your-slug "401": { $ref: "#/components/responses/Unauthorized" } "404": { $ref: "#/components/responses/NotFound" } /status-page-updates: post: tags: [Status Page Updates] summary: Create a status page update description: Create a new status page update by providing the status page ID, title, text, severity, time, and pinned status. operationId: createStatusPageUpdate requestBody: description: The body of the status page update to create. required: true content: application/json: schema: $ref: "#/components/schemas/CreateStatusPageUpdateRequest" examples: example: value: status_page_id: 1 title: Our site is down text: We are working on it! severity: high time: "2019-09-16 10:24" pinned: true responses: "201": description: Created content: application/json: schema: $ref: "#/components/schemas/StatusPageUpdate" examples: success: value: id: 66 title: Our site is down text: We are working on it! pinned: true severity: high time: "2019-09-16 08:24:00" status_page_url: https://ohdear.app/status-page/your-slug "401": { $ref: "#/components/responses/Unauthorized" } "403": { $ref: "#/components/responses/Forbidden" } "422": { $ref: "#/components/responses/Validation" } /status-page-updates/{statusPageUpdateId}: put: tags: [Status Page Updates] summary: Update a status page update description: Update an existing status page update by its ID. operationId: updateStatusPageUpdate parameters: - name: statusPageUpdateId description: ID of the status page update in: path required: true schema: { type: integer } requestBody: required: true content: application/json: schema: $ref: "#/components/schemas/UpdateStatusPageUpdateRequest" responses: "200": description: Status page update updated content: application/json: schema: $ref: "#/components/schemas/StatusPageUpdate" "401": { $ref: "#/components/responses/Unauthorized" } "404": { $ref: "#/components/responses/NotFound" } "422": { $ref: "#/components/responses/Validation" } delete: tags: [Status Page Updates] summary: Delete a status page update description: Delete a specific status page update by its ID. This action is irreversible. operationId: deleteStatusPageUpdate parameters: - name: statusPageUpdateId description: ID of the status page update in: path required: true schema: { type: integer } responses: "204": { $ref: "#/components/responses/NoContent" } "401": { $ref: "#/components/responses/Unauthorized" } "404": { $ref: "#/components/responses/NotFound" } /monitors/{monitorId}/cron-checks: get: tags: [Cron Checks] summary: List cron checks for a monitor description: Retrieve a list of cron checks associated with a specific monitor. operationId: listCronChecks parameters: - $ref: "#/components/parameters/MonitorId" responses: "200": description: Cron checks content: application/json: schema: $ref: "#/components/schemas/CronChecksResponse" examples: success: value: data: - id: 1 uuid: 0d210b09 name: cronjob number one type: simple description: a description goes here frequency_in_minutes: 15 grace_time_in_minutes: 5 cron_expression: null server_timezone: Europe/Brussels ping_url: https://ping.ohdear.app/0d210b09 created_at: "2020-07-28 13:27:02" latest_result: pingFinished latest_ping_at: "2020-11-16 09:19:40" human_readable_latest_ping_at: "5 minutes ago" "401": { $ref: "#/components/responses/Unauthorized" } "404": { $ref: "#/components/responses/NotFound" } post: tags: [Cron Checks] summary: Create a cron check description: | Create a new cron job monitor for a specific monitor. You can create either a simple cron check (with frequency) or a cron expression-based check. For simple type: provide `frequency_in_minutes` and `grace_time_in_minutes`. For cron type: provide `cron_expression`, `grace_time_in_minutes`, and `server_timezone`. operationId: createCronCheck parameters: - $ref: "#/components/parameters/MonitorId" requestBody: required: true content: application/json: schema: $ref: "#/components/schemas/CreateCronCheckRequest" examples: simple: summary: Simple frequency-based cron check value: name: your cron job name type: simple frequency_in_minutes: 10 grace_time_in_minutes: 15 description: a description goes here cron: summary: Cron expression-based check value: name: your cron job name type: cron cron_expression: "* * * * *" grace_time_in_minutes: 10 description: a description goes here server_timezone: UTC responses: "201": description: Cron check created content: application/json: schema: $ref: "#/components/schemas/CronCheck" examples: success: value: id: 12 uuid: ba4322cf name: your cron job name type: simple description: a description goes here frequency_in_minutes: 10 grace_time_in_minutes: 15 cron_expression: "" server_timezone: null ping_url: https://ping.ohdear.app/ba4322cf created_at: "2020-08-03 12:18:33" "401": { $ref: "#/components/responses/Unauthorized" } "403": { $ref: "#/components/responses/Forbidden" } "404": { $ref: "#/components/responses/NotFound" } "422": { $ref: "#/components/responses/Validation" } /monitors/{monitorId}/cron-checks/sync: post: tags: [Cron Checks] summary: Bulk sync cron checks description: | Synchronize all cron checks for a monitor. This is a destructive action - any cron job not included in the sync request will be removed. Useful for managing cron checks programmatically, such as from the PHP SDK. operationId: syncCronChecks parameters: - $ref: "#/components/parameters/MonitorId" requestBody: required: true content: application/json: schema: $ref: "#/components/schemas/SyncCronChecksRequest" examples: sync: value: cron_checks: - name: cron job #1 type: cron cron_expression: "* * * * *" grace_time_in_minutes: 10 description: description for cron #1 server_timezone: UTC - name: cron job #2 type: cron cron_expression: "0 * * * *" grace_time_in_minutes: 10 description: description for cron #2 server_timezone: UTC responses: "200": description: Cron checks synchronized content: application/json: schema: type: array items: $ref: "#/components/schemas/CronCheck" examples: success: value: - id: 9 uuid: c1803dce name: cron job #1 type: cron description: description for cron #1 frequency_in_minutes: null grace_time_in_minutes: 10 cron_expression: "* * * * *" server_timezone: UTC ping_url: https://ping.ohdear.app/c1803dce created_at: "2020-09-03 19:20:25" latest_result: pingFinished latest_ping_at: "2020-11-16 09:19:40" - id: 10 uuid: 40e8e39e name: cron job #2 type: cron description: description for cron #2 frequency_in_minutes: null grace_time_in_minutes: 10 cron_expression: "0 * * * *" server_timezone: UTC ping_url: https://ping.ohdear.app/40e8e39e created_at: "2020-09-03 19:20:25" latest_result: pingFinished latest_ping_at: "2020-11-16 09:19:40" "401": { $ref: "#/components/responses/Unauthorized" } "404": { $ref: "#/components/responses/NotFound" } "422": { $ref: "#/components/responses/Validation" } /cron-checks/{cronCheckDefinitionId}: put: tags: [Cron Checks] summary: Update a cron check description: Update an existing cron check definition. operationId: updateCronCheck parameters: - $ref: "#/components/parameters/CronCheckDefinitionId" requestBody: required: true content: application/json: schema: $ref: "#/components/schemas/UpdateCronCheckRequest" responses: "200": description: Cron check updated content: application/json: schema: $ref: "#/components/schemas/CronCheck" "401": { $ref: "#/components/responses/Unauthorized" } "404": { $ref: "#/components/responses/NotFound" } "422": { $ref: "#/components/responses/Validation" } delete: tags: [Cron Checks] summary: Delete a cron check description: Delete a specific cron check by its ID. This action cannot be undone. operationId: deleteCronCheck parameters: - $ref: "#/components/parameters/CronCheckDefinitionId" responses: "204": { $ref: "#/components/responses/NoContent" } "401": { $ref: "#/components/responses/Unauthorized" } "404": { $ref: "#/components/responses/NotFound" } /monitors/{monitorId}/dns-history-items: get: tags: [DNS] summary: Get DNS history description: Retrieve the DNS history and any issues detected for a monitor's domain. Results are sorted in reverse chronological order. operationId: getDnsHistory parameters: - $ref: "#/components/parameters/MonitorId" - $ref: "#/components/parameters/FilterCreatedAt" responses: "200": description: DNS history items content: application/json: schema: $ref: "#/components/schemas/DnsHistoryResponse" examples: success: value: data: - id: 2 authoritative_nameservers: - ns1.example.com - ns2.example.com dns_records: - host: example.com ttl: 1017 class: IN type: A ip: 93.184.216.34 raw_dns_records: ns1.example.com: - "example.com. 1017 IN A 93.184.216.34" issues: [] diff_summary: No changes created_at: "2021-11-05 16:07:38" "401": { $ref: "#/components/responses/Unauthorized" } "404": { $ref: "#/components/responses/NotFound" } /monitors/{monitorId}/domain: get: tags: [Domain] summary: Get domain information description: Retrieve domain registration information from RDAP for a monitor's domain, including expiration dates and domain statuses. operationId: getDomainInfo parameters: - $ref: "#/components/parameters/MonitorId" responses: "200": description: Domain information content: application/json: schema: $ref: "#/components/schemas/DomainInfo" examples: success: value: expires_at: "2028-09-14 04:00:00" registered_at: "1997-09-15 04:00:00" last_changed_at: "2019-09-09 15:39:04" last_updated_in_rdap_db_at: "2022-06-11 00:32:59" domain_statuses: client delete prohibited: true client transfer prohibited: true client update prohibited: true rdap_domain_response: {} created_at: "2022-06-10 20:33:06" "401": { $ref: "#/components/responses/Unauthorized" } "404": { $ref: "#/components/responses/NotFound" } /monitors/{monitorId}/application-health-checks/{applicationHealthCheckId}: get: tags: [Application Health Checks] summary: Get application health check history description: Retrieve the history of results for a specific application health check. Newest items appear first. operationId: getApplicationHealthCheckHistory parameters: - $ref: "#/components/parameters/MonitorId" - $ref: "#/components/parameters/ApplicationHealthCheckId" responses: "200": description: Application health check history content: application/json: schema: $ref: "#/components/schemas/ApplicationHealthCheckHistoryResponse" examples: success: value: data: - id: 2 status: ok message: "" short_summary: "60%" meta: usage: 60 detected_at: "2021-01-01 00:01:00" updated_at: "2021-01-01 00:01:00" - id: 1 status: failed message: The disk is nearly full (91%) short_summary: "91%" meta: usage: 91 detected_at: "2021-01-01 00:00:00" updated_at: "2021-01-01 00:00:00" "401": { $ref: "#/components/responses/Unauthorized" } "404": { $ref: "#/components/responses/NotFound" } /monitors/{monitorId}/lighthouse-reports: get: tags: [Lighthouse] summary: List Lighthouse reports description: Retrieve all Lighthouse SEO reports for a monitor. The json_report field is not included in this list response. operationId: listLighthouseReports parameters: - $ref: "#/components/parameters/MonitorId" - $ref: "#/components/parameters/PageNumber" - $ref: "#/components/parameters/PageSize" - $ref: "#/components/parameters/FilterCreatedAt" responses: "200": description: Paginated Lighthouse reports content: application/json: schema: $ref: "#/components/schemas/PaginatedLighthouseReports" examples: success: value: data: - id: 1423 performance_score: 97 accessibility_score: 98 best_practices_score: 92 seo_score: 92 progressive_web_app_score: 30 first_contentful_paint_in_ms: 1851.45 speed_index_in_ms: 1866 largest_contentful_paint_in_ms: 1851.45 time_to_interactive_in_ms: 2473.87 total_blocking_time_in_ms: 123.77 cumulative_layout_shift: 0.01 performed_on_checker_server: lighthouse-checker-frankfurt-1 issues: [] created_at: "2023-01-14 00:00:55" links: first: https://ohdear.app/api/monitors/1/lighthouse-reports?page%5Bnumber%5D=1 last: https://ohdear.app/api/monitors/1/lighthouse-reports?page%5Bnumber%5D=1 prev: null next: null meta: current_page: 1 from: 1 last_page: 1 per_page: 200 to: 1 total: 1 "401": { $ref: "#/components/responses/Unauthorized" } "404": { $ref: "#/components/responses/NotFound" } /monitors/{monitorId}/lighthouse-reports/latest: get: tags: [Lighthouse] summary: Get latest Lighthouse report description: Retrieve the most recent Lighthouse SEO report for a monitor, including the full json_report. operationId: getLatestLighthouseReport parameters: - $ref: "#/components/parameters/MonitorId" responses: "200": description: Latest Lighthouse report content: application/json: schema: $ref: "#/components/schemas/LighthouseReport" examples: success: value: id: 1 performance_score: 50 accessibility_score: 98 best_practices_score: 92 seo_score: 92 progressive_web_app_score: 30 first_contentful_paint_in_ms: 1851.45 speed_index_in_ms: 1866 largest_contentful_paint_in_ms: 1851.45 time_to_interactive_in_ms: 2473.87 total_blocking_time_in_ms: 123.77 cumulative_layout_shift: 0.01 performed_on_checker_server: lighthouse-checker-frankfurt-1 json_report: {} issues: - category: performance actualScore: 50 notificationThreshold: 70 created_at: "2023-01-14 00:00:55" "401": { $ref: "#/components/responses/Unauthorized" } "404": { $ref: "#/components/responses/NotFound" } /monitors/{monitorId}/lighthouse-reports/{lighthouseReportId}: get: tags: [Lighthouse] summary: Get a specific Lighthouse report description: Retrieve a specific Lighthouse SEO report by ID, including the full json_report. operationId: getLighthouseReport parameters: - $ref: "#/components/parameters/MonitorId" - $ref: "#/components/parameters/LighthouseReportId" responses: "200": description: Lighthouse report content: application/json: schema: $ref: "#/components/schemas/LighthouseReport" "401": { $ref: "#/components/responses/Unauthorized" } "404": { $ref: "#/components/responses/NotFound" } /monitors/{monitorId}/ai-responses: get: tags: [AI] summary: List AI responses description: Retrieve all AI responses for a monitor. operationId: listAiResponses parameters: - $ref: "#/components/parameters/MonitorId" - $ref: "#/components/parameters/PageNumber" - $ref: "#/components/parameters/PageSize" - $ref: "#/components/parameters/FilterCreatedAt" responses: "200": description: Paginated AI responses content: application/json: schema: $ref: "#/components/schemas/PaginatedAiResponses" examples: success: value: data: - id: 2 result: ok finish_reason: stop prompt: Check the status of this website and provide insights on any issues. text: Your site is running perfectly. All checks passed. notification_title: null notification_body: null used_tools: - name: fetch_url arguments: url: https://example.com displayName: Fetch URL displayArguments: - https://example.com used_prompt_tokens: 120 used_completion_tokens: 45 started_at: "2024-01-15 11:15:25" ended_at: "2024-01-15 11:15:30" created_at: "2024-01-15 11:15:30" links: first: https://ohdear.app/api/monitors/1/ai-responses?page%5Bnumber%5D=1 last: https://ohdear.app/api/monitors/1/ai-responses?page%5Bnumber%5D=1 prev: null next: null meta: current_page: 1 from: 1 last_page: 1 per_page: 200 to: 1 total: 1 "401": { $ref: "#/components/responses/Unauthorized" } "404": { $ref: "#/components/responses/NotFound" } /monitors/{monitorId}/ai-responses/latest: get: tags: [AI] summary: Get latest AI response description: Retrieve the most recent AI response for a monitor, including the raw_response. operationId: getLatestAiResponse parameters: - $ref: "#/components/parameters/MonitorId" responses: "200": description: Latest AI response content: application/json: schema: $ref: "#/components/schemas/AiResponse" examples: success: value: id: 1 result: failed finish_reason: stop prompt: Check the status of this website and provide insights on any issues. text: Your site appears to be down. HTTP 500 error detected. notification_title: Site Issue Detected notification_body: Your website is returning a 500 error. Please check your server logs. used_tools: - name: fetch_url arguments: url: https://example.com displayName: Fetch URL displayArguments: - https://example.com - name: check_ssl arguments: url: https://example.com displayName: Check SSL displayArguments: - https://example.com used_prompt_tokens: 150 used_completion_tokens: 75 raw_response: '{"response": {"message": "Site down"}}' started_at: "2024-01-15 10:30:40" ended_at: "2024-01-15 10:30:45" created_at: "2024-01-15 10:30:45" "401": { $ref: "#/components/responses/Unauthorized" } "404": { $ref: "#/components/responses/NotFound" } /monitors/{monitorId}/ai-responses/{aiResponseId}: get: tags: [AI] summary: Get a specific AI response description: Retrieve a specific AI response by ID, including the raw_response. operationId: getAiResponse parameters: - $ref: "#/components/parameters/MonitorId" - $ref: "#/components/parameters/AiResponseId" responses: "200": description: AI response content: application/json: schema: $ref: "#/components/schemas/AiResponse" "401": { $ref: "#/components/responses/Unauthorized" } "404": { $ref: "#/components/responses/NotFound" } /tags: get: tags: [Tags] summary: List all tags description: Retrieve all tags for your teams. operationId: listTags responses: "200": description: List of tags content: application/json: schema: $ref: "#/components/schemas/TagsResponse" examples: success: value: data: - id: 22 team_id: 5 team_name: Oh Dear name: production slug: production created_at: "2025-08-15 09:00:00" updated_at: "2025-08-15 09:00:00" sites: - 17 - 317 "401": { $ref: "#/components/responses/Unauthorized" } "403": { $ref: "#/components/responses/Forbidden" } post: tags: [Tags] summary: Create a tag description: Create a new tag for your team. operationId: createTag requestBody: required: true content: application/json: schema: $ref: "#/components/schemas/CreateTagRequest" examples: basic: value: team_id: 5 name: production sites: - 17 - 317 responses: "201": description: Tag created content: application/json: schema: $ref: "#/components/schemas/Tag" "401": { $ref: "#/components/responses/Unauthorized" } "403": { $ref: "#/components/responses/Forbidden" } "404": { $ref: "#/components/responses/NotFound" } "422": { $ref: "#/components/responses/Validation" } /tag-groups: get: tags: [Tag Groups] summary: List all tag groups description: Retrieve all tag groups for your teams. operationId: listTagGroups parameters: - $ref: "#/components/parameters/PageNumber" - $ref: "#/components/parameters/PageSize" responses: "200": description: Paginated list of tag groups content: application/json: schema: $ref: "#/components/schemas/PaginatedTagGroups" examples: success: value: data: - id: 6 label: VIP Client Production Sites team_id: 5 team_name: Oh Dear created_at: "2025-08-15 09:00:00" updated_at: "2025-08-15 09:00:00" tags: - id: 77 team_id: 5 team_name: Oh Dear name: VIP slug: vip created_at: "2025-08-15 09:00:00" updated_at: "2025-08-15 09:00:00" sites: [] links: first: https://ohdear.app/api/tag-groups?page%5Bnumber%5D=1 last: https://ohdear.app/api/tag-groups?page%5Bnumber%5D=1 prev: null next: null meta: current_page: 1 from: 1 last_page: 1 per_page: 200 to: 1 total: 1 "401": { $ref: "#/components/responses/Unauthorized" } "403": { $ref: "#/components/responses/Forbidden" } post: tags: [Tag Groups] summary: Create a tag group description: Create a new tag group for your team. Any tags that do not exist will be created. operationId: createTagGroup requestBody: required: true content: application/json: schema: $ref: "#/components/schemas/CreateTagGroupRequest" examples: basic: value: team_id: 5 label: VIP Client Production Sites tags: - VIP - production - "*client*" responses: "201": description: Tag group created content: application/json: schema: $ref: "#/components/schemas/TagGroup" "401": { $ref: "#/components/responses/Unauthorized" } "403": { $ref: "#/components/responses/Forbidden" } "404": { $ref: "#/components/responses/NotFound" } "422": { $ref: "#/components/responses/Validation" } /tag-groups/{tagGroupId}: put: tags: [Tag Groups] summary: Update a tag group description: Update an existing tag group. An empty tags array will remove all tags from the group. Omit the tags property to only update the label. operationId: updateTagGroup parameters: - $ref: "#/components/parameters/TagGroupId" requestBody: required: true content: application/json: schema: $ref: "#/components/schemas/UpdateTagGroupRequest" examples: updateLabel: value: label: Updated Label updateTags: value: label: VIP Client Production Sites tags: - VIP - production - "*client*" - additional-tag responses: "200": description: Tag group updated content: application/json: schema: $ref: "#/components/schemas/TagGroup" "401": { $ref: "#/components/responses/Unauthorized" } "404": { $ref: "#/components/responses/NotFound" } "422": { $ref: "#/components/responses/Validation" } delete: tags: [Tag Groups] summary: Delete a tag group description: Delete an existing tag group. operationId: deleteTagGroup parameters: - $ref: "#/components/parameters/TagGroupId" responses: "204": { $ref: "#/components/responses/NoContent" } "401": { $ref: "#/components/responses/Unauthorized" } "404": { $ref: "#/components/responses/NotFound" } /team-notification-destinations: get: tags: [Notification Destinations] summary: Get team notification destinations description: Retrieve all notification destinations defined at the team level for all your teams. Only team owners, admins, and members with access to all monitors see a team's destinations. operationId: listTeamNotificationDestinations responses: "200": description: Team notification destinations content: application/json: schema: $ref: "#/components/schemas/TeamNotificationDestinationsResponse" examples: success: value: data: - id: 123 team_id: 1 channel: mail destination: mail: john@example.com notification_types: - HttpUptimeCheckFailedNotification - HttpUptimeCheckRecoveredNotification "401": { $ref: "#/components/responses/Unauthorized" } "403": { $ref: "#/components/responses/Forbidden" } /team-notification-destinations/{teamId}: post: tags: [Notification Destinations] summary: Create team notification destination description: Create a new notification destination for a team. Only team owners, admins, and members with access to all monitors can access this endpoint. operationId: createTeamNotificationDestination parameters: - $ref: "#/components/parameters/TeamId" requestBody: required: true content: application/json: schema: $ref: "#/components/schemas/CreateNotificationDestinationRequest" examples: mail: value: channel: mail destination: mail: example@example.com notification_types: - UptimeCheckRecoveredNotification - UptimeCheckFailedNotification allEvents: value: channel: mail destination: mail: example@example.com withTest: value: test: true channel: mail destination: mail: example@example.com responses: "201": description: Notification destination created content: application/json: schema: $ref: "#/components/schemas/TeamNotificationDestination" "401": { $ref: "#/components/responses/Unauthorized" } "404": { $ref: "#/components/responses/NotFound" } "422": { $ref: "#/components/responses/Validation" } /team-notification-destinations/{teamId}/destination/{destinationId}: put: tags: [Notification Destinations] summary: Update team notification destination description: Update an existing notification destination for a team. Only team owners, admins, and members with access to all monitors can access this endpoint. operationId: updateTeamNotificationDestination parameters: - $ref: "#/components/parameters/TeamId" - $ref: "#/components/parameters/DestinationId" requestBody: required: true content: application/json: schema: $ref: "#/components/schemas/UpdateNotificationDestinationRequest" examples: update: value: test: true channel: mail destination: mail: updated@example.com responses: "200": description: Notification destination updated content: application/json: schema: $ref: "#/components/schemas/TeamNotificationDestination" "401": { $ref: "#/components/responses/Unauthorized" } "404": { $ref: "#/components/responses/NotFound" } "422": { $ref: "#/components/responses/Validation" } delete: tags: [Notification Destinations] summary: Delete team notification destination description: Delete a notification destination from a team. Only team owners, admins, and members with access to all monitors can access this endpoint. operationId: deleteTeamNotificationDestination parameters: - $ref: "#/components/parameters/TeamId" - $ref: "#/components/parameters/DestinationId" responses: "204": { $ref: "#/components/responses/NoContent" } "401": { $ref: "#/components/responses/Unauthorized" } "404": { $ref: "#/components/responses/NotFound" } /team-notification-destinations/{teamId}/destination/{destinationId}/enable: post: tags: [Notification Destinations] summary: Enable team notification destination description: Re-enable a previously disabled notification destination for a team. Keeps all settings and selected notification types, clears any automatic disable reason, and resumes sending notifications. Takes no request body and never sends an email. Only team owners, admins, and members with access to all monitors can access this endpoint. operationId: enableTeamNotificationDestination parameters: - $ref: "#/components/parameters/TeamId" - $ref: "#/components/parameters/DestinationId" responses: "200": description: Notification destination enabled content: application/json: schema: $ref: "#/components/schemas/TeamNotificationDestination" "401": { $ref: "#/components/responses/Unauthorized" } "404": { $ref: "#/components/responses/NotFound" } /team-notification-destinations/{teamId}/destination/{destinationId}/disable: post: tags: [Notification Destinations] summary: Disable team notification destination description: Disable a notification destination for a team without deleting it. Keeps all settings and selected notification types but pauses sending notifications until it is enabled again. Takes no request body and never sends an email. Only team owners, admins, and members with access to all monitors can access this endpoint. operationId: disableTeamNotificationDestination parameters: - $ref: "#/components/parameters/TeamId" - $ref: "#/components/parameters/DestinationId" responses: "200": description: Notification destination disabled content: application/json: schema: $ref: "#/components/schemas/TeamNotificationDestination" "401": { $ref: "#/components/responses/Unauthorized" } "404": { $ref: "#/components/responses/NotFound" } /monitors/{monitorId}/notification-destinations: get: tags: [Notification Destinations] summary: Get monitor notification destinations description: Retrieve all notification destinations for a specific monitor. Any team member with access to the monitor can access this endpoint. operationId: listMonitorNotificationDestinations parameters: - $ref: "#/components/parameters/MonitorId" responses: "200": description: Monitor notification destinations content: application/json: schema: $ref: "#/components/schemas/MonitorNotificationDestinationsResponse" examples: success: value: data: - id: 456 channel: mail destination: mail: john@example.com notification_types: - HttpUptimeCheckFailedNotification - HttpUptimeCheckRecoveredNotification "401": { $ref: "#/components/responses/Unauthorized" } "404": { $ref: "#/components/responses/NotFound" } post: tags: [Notification Destinations] summary: Create monitor notification destination description: Create a new notification destination for a monitor. Team owners, admins, and members with access to the monitor can access this endpoint. Guests of the team cannot. operationId: createMonitorNotificationDestination parameters: - $ref: "#/components/parameters/MonitorId" requestBody: required: true content: application/json: schema: $ref: "#/components/schemas/CreateNotificationDestinationRequest" examples: mail: value: channel: mail destination: mail: example@example.com notification_types: - UptimeCheckRecoveredNotification - UptimeCheckFailedNotification responses: "201": description: Notification destination created content: application/json: schema: $ref: "#/components/schemas/MonitorNotificationDestination" "401": { $ref: "#/components/responses/Unauthorized" } "404": { $ref: "#/components/responses/NotFound" } "422": { $ref: "#/components/responses/Validation" } /monitors/{monitorId}/notification-destinations/{destinationId}: put: tags: [Notification Destinations] summary: Update monitor notification destination description: Update an existing notification destination for a monitor. Team owners, admins, and members with access to the monitor can access this endpoint. Guests of the team cannot. operationId: updateMonitorNotificationDestination parameters: - $ref: "#/components/parameters/MonitorId" - $ref: "#/components/parameters/DestinationId" requestBody: required: true content: application/json: schema: $ref: "#/components/schemas/UpdateNotificationDestinationRequest" responses: "200": description: Notification destination updated content: application/json: schema: $ref: "#/components/schemas/MonitorNotificationDestination" "401": { $ref: "#/components/responses/Unauthorized" } "404": { $ref: "#/components/responses/NotFound" } "422": { $ref: "#/components/responses/Validation" } delete: tags: [Notification Destinations] summary: Delete monitor notification destination description: Delete a notification destination from a monitor. Team owners, admins, and members with access to the monitor can access this endpoint. Guests of the team cannot. operationId: deleteMonitorNotificationDestination parameters: - $ref: "#/components/parameters/MonitorId" - $ref: "#/components/parameters/DestinationId" responses: "204": { $ref: "#/components/responses/NoContent" } "401": { $ref: "#/components/responses/Unauthorized" } "404": { $ref: "#/components/responses/NotFound" } /monitors/{monitorId}/notification-destinations/{destinationId}/enable: post: tags: [Notification Destinations] summary: Enable monitor notification destination description: Re-enable a previously disabled notification destination for a monitor. Keeps all settings and selected notification types, clears any automatic disable reason, and resumes sending notifications. Takes no request body and never sends an email. Team owners, admins, and members with access to the monitor can access this endpoint. Guests of the team cannot. operationId: enableMonitorNotificationDestination parameters: - $ref: "#/components/parameters/MonitorId" - $ref: "#/components/parameters/DestinationId" responses: "200": description: Notification destination enabled content: application/json: schema: $ref: "#/components/schemas/MonitorNotificationDestination" "401": { $ref: "#/components/responses/Unauthorized" } "404": { $ref: "#/components/responses/NotFound" } /monitors/{monitorId}/notification-destinations/{destinationId}/disable: post: tags: [Notification Destinations] summary: Disable monitor notification destination description: Disable a notification destination for a monitor without deleting it. Keeps all settings and selected notification types but pauses sending notifications until it is enabled again. Takes no request body and never sends an email. Team owners, admins, and members with access to the monitor can access this endpoint. Guests of the team cannot. operationId: disableMonitorNotificationDestination parameters: - $ref: "#/components/parameters/MonitorId" - $ref: "#/components/parameters/DestinationId" responses: "200": description: Notification destination disabled content: application/json: schema: $ref: "#/components/schemas/MonitorNotificationDestination" "401": { $ref: "#/components/responses/Unauthorized" } "404": { $ref: "#/components/responses/NotFound" } /tags/notification-destinations: get: tags: [Notification Destinations] summary: Get tag notification destinations description: Retrieve all notification destinations defined at the tag level for all your teams. Only team owners, admins, and members with access to all monitors can access this endpoint. operationId: listTagNotificationDestinations responses: "200": description: Tag notification destinations content: application/json: schema: $ref: "#/components/schemas/TagNotificationDestinationsResponse" examples: success: value: data: - id: 123 tag: id: 1 name: Production slug: production team_id: 1 channel: mail destination: mail: john@example.com notification_types: - HttpUptimeCheckFailedNotification - HttpUptimeCheckRecoveredNotification "401": { $ref: "#/components/responses/Unauthorized" } "403": { $ref: "#/components/responses/Forbidden" } /tags/{tagId}/notification-destinations: post: tags: [Notification Destinations] summary: Create tag notification destination description: Create a new notification destination for a tag. Only team owners, admins, and members with access to all monitors can access this endpoint. operationId: createTagNotificationDestination parameters: - $ref: "#/components/parameters/TagId" requestBody: required: true content: application/json: schema: $ref: "#/components/schemas/CreateNotificationDestinationRequest" responses: "201": description: Notification destination created content: application/json: schema: $ref: "#/components/schemas/TagNotificationDestination" "401": { $ref: "#/components/responses/Unauthorized" } "404": { $ref: "#/components/responses/NotFound" } "422": { $ref: "#/components/responses/Validation" } /tags/{tagId}/notification-destinations/{destinationId}: put: tags: [Notification Destinations] summary: Update tag notification destination description: Update an existing notification destination for a tag. Only team owners, admins, and members with access to all monitors can access this endpoint. operationId: updateTagNotificationDestination parameters: - $ref: "#/components/parameters/TagId" - $ref: "#/components/parameters/DestinationId" requestBody: required: true content: application/json: schema: $ref: "#/components/schemas/UpdateNotificationDestinationRequest" responses: "200": description: Notification destination updated content: application/json: schema: $ref: "#/components/schemas/TagNotificationDestination" "401": { $ref: "#/components/responses/Unauthorized" } "404": { $ref: "#/components/responses/NotFound" } "422": { $ref: "#/components/responses/Validation" } /tags/{tagId}/notification-destinations/destination/{destinationId}: delete: tags: [Notification Destinations] summary: Delete tag notification destination description: Delete a notification destination from a tag. Only team owners, admins, and members with access to all monitors can access this endpoint. operationId: deleteTagNotificationDestination parameters: - $ref: "#/components/parameters/TagId" - $ref: "#/components/parameters/DestinationId" responses: "204": { $ref: "#/components/responses/NoContent" } "401": { $ref: "#/components/responses/Unauthorized" } "404": { $ref: "#/components/responses/NotFound" } /tags/{tagId}/notification-destinations/{destinationId}/enable: post: tags: [Notification Destinations] summary: Enable tag notification destination description: Re-enable a previously disabled notification destination for a tag. Keeps all settings and selected notification types, clears any automatic disable reason, and resumes sending notifications. Takes no request body and never sends an email. Only team owners, admins, and members with access to all monitors can access this endpoint. operationId: enableTagNotificationDestination parameters: - $ref: "#/components/parameters/TagId" - $ref: "#/components/parameters/DestinationId" responses: "200": description: Notification destination enabled content: application/json: schema: $ref: "#/components/schemas/TagNotificationDestination" "401": { $ref: "#/components/responses/Unauthorized" } "404": { $ref: "#/components/responses/NotFound" } /tags/{tagId}/notification-destinations/{destinationId}/disable: post: tags: [Notification Destinations] summary: Disable tag notification destination description: Disable a notification destination for a tag without deleting it. Keeps all settings and selected notification types but pauses sending notifications until it is enabled again. Takes no request body and never sends an email. Only team owners, admins, and members with access to all monitors can access this endpoint. operationId: disableTagNotificationDestination parameters: - $ref: "#/components/parameters/TagId" - $ref: "#/components/parameters/DestinationId" responses: "200": description: Notification destination disabled content: application/json: schema: $ref: "#/components/schemas/TagNotificationDestination" "401": { $ref: "#/components/responses/Unauthorized" } "404": { $ref: "#/components/responses/NotFound" } /tag-groups/{tagGroupId}/notification-destinations: get: tags: [Notification Destinations] summary: Get tag group notification destinations description: Retrieve all notification destinations for a specific tag group. Only team owners, admins, and members with access to all monitors can access this endpoint. operationId: listTagGroupNotificationDestinations parameters: - $ref: "#/components/parameters/TagGroupId" responses: "200": description: Tag group notification destinations content: application/json: schema: $ref: "#/components/schemas/TagGroupNotificationDestinationsResponse" examples: success: value: data: - id: 158 tagGroup: id: 1 label: VIP Client Production Sites team_id: 5 team_name: Oh Dear created_at: "2025-08-01 09:00:00" updated_at: "2025-08-01 09:00:00" tags: [] channel: slackApi destination: channel: "#monitoring" slack_api_token: "xoxp-2..." notification_types: - UptimeCheckFailedNotification - UptimeCheckRecoveredNotification "401": { $ref: "#/components/responses/Unauthorized" } "404": { $ref: "#/components/responses/NotFound" } post: tags: [Notification Destinations] summary: Create tag group notification destination description: Create a new notification destination for a tag group. Only team owners, admins, and members with access to all monitors can access this endpoint. operationId: createTagGroupNotificationDestination parameters: - $ref: "#/components/parameters/TagGroupId" requestBody: required: true content: application/json: schema: $ref: "#/components/schemas/CreateNotificationDestinationRequest" responses: "201": description: Notification destination created content: application/json: schema: $ref: "#/components/schemas/TagGroupNotificationDestination" "401": { $ref: "#/components/responses/Unauthorized" } "404": { $ref: "#/components/responses/NotFound" } "422": { $ref: "#/components/responses/Validation" } /tag-groups/{tagGroupId}/notification-destinations/{destinationId}: put: tags: [Notification Destinations] summary: Update tag group notification destination description: Update an existing notification destination for a tag group. Only team owners, admins, and members with access to all monitors can access this endpoint. operationId: updateTagGroupNotificationDestination parameters: - $ref: "#/components/parameters/TagGroupId" - $ref: "#/components/parameters/DestinationId" requestBody: required: true content: application/json: schema: $ref: "#/components/schemas/UpdateNotificationDestinationRequest" responses: "200": description: Notification destination updated content: application/json: schema: $ref: "#/components/schemas/TagGroupNotificationDestination" "401": { $ref: "#/components/responses/Unauthorized" } "404": { $ref: "#/components/responses/NotFound" } "422": { $ref: "#/components/responses/Validation" } delete: tags: [Notification Destinations] summary: Delete tag group notification destination description: Delete a notification destination from a tag group. Only team owners, admins, and members with access to all monitors can access this endpoint. operationId: deleteTagGroupNotificationDestination parameters: - $ref: "#/components/parameters/TagGroupId" - $ref: "#/components/parameters/DestinationId" responses: "204": { $ref: "#/components/responses/NoContent" } "401": { $ref: "#/components/responses/Unauthorized" } "404": { $ref: "#/components/responses/NotFound" } /tag-groups/{tagGroupId}/notification-destinations/{destinationId}/enable: post: tags: [Notification Destinations] summary: Enable tag group notification destination description: Re-enable a previously disabled notification destination for a tag group. Keeps all settings and selected notification types, clears any automatic disable reason, and resumes sending notifications. Takes no request body and never sends an email. Only team owners, admins, and members with access to all monitors can access this endpoint. operationId: enableTagGroupNotificationDestination parameters: - $ref: "#/components/parameters/TagGroupId" - $ref: "#/components/parameters/DestinationId" responses: "200": description: Notification destination enabled content: application/json: schema: $ref: "#/components/schemas/TagGroupNotificationDestination" "401": { $ref: "#/components/responses/Unauthorized" } "404": { $ref: "#/components/responses/NotFound" } /tag-groups/{tagGroupId}/notification-destinations/{destinationId}/disable: post: tags: [Notification Destinations] summary: Disable tag group notification destination description: Disable a notification destination for a tag group without deleting it. Keeps all settings and selected notification types but pauses sending notifications until it is enabled again. Takes no request body and never sends an email. Only team owners, admins, and members with access to all monitors can access this endpoint. operationId: disableTagGroupNotificationDestination parameters: - $ref: "#/components/parameters/TagGroupId" - $ref: "#/components/parameters/DestinationId" responses: "200": description: Notification destination disabled content: application/json: schema: $ref: "#/components/schemas/TagGroupNotificationDestination" "401": { $ref: "#/components/responses/Unauthorized" } "404": { $ref: "#/components/responses/NotFound" } /reseller/{resellerTeamId}/managed-teams: get: tags: [Reseller] summary: List all managed teams description: Retrieve all teams managed by your reseller account. operationId: listManagedTeams parameters: - $ref: "#/components/parameters/ResellerTeamId" - $ref: "#/components/parameters/FilterName" - $ref: "#/components/parameters/FilterTimezone" - $ref: "#/components/parameters/Sort" - $ref: "#/components/parameters/Page" responses: "200": description: Paginated list of managed teams content: application/json: schema: $ref: "#/components/schemas/PaginatedManagedTeams" examples: success: value: data: - id: 12345 name: Client Company timezone: UTC created_at: "2024-01-15T10:30:00.000000Z" monitors_count: 5 - id: 12346 name: Another Client timezone: Europe/Brussels created_at: "2024-01-20T14:15:00.000000Z" monitors_count: 12 links: first: https://ohdear.app/api/reseller/11111/managed-teams?page=1 last: https://ohdear.app/api/reseller/11111/managed-teams?page=1 prev: null next: null meta: current_page: 1 from: 1 last_page: 1 per_page: 15 to: 2 total: 2 "401": { $ref: "#/components/responses/Unauthorized" } "404": { $ref: "#/components/responses/NotFound" } post: tags: [Reseller] summary: Create a managed team description: Create a new team that will be managed by your reseller account. operationId: createManagedTeam parameters: - $ref: "#/components/parameters/ResellerTeamId" requestBody: required: true content: application/json: schema: $ref: "#/components/schemas/CreateManagedTeamRequest" examples: basic: value: name: New Client Company timezone: Europe/Brussels default_uptime_check_location: paris responses: "201": description: Managed team created content: application/json: schema: $ref: "#/components/schemas/ManagedTeamResponse" examples: success: value: data: id: 12347 name: New Client Company timezone: Europe/Brussels created_at: "2024-01-25T09:00:00.000000Z" monitors_count: 0 "401": { $ref: "#/components/responses/Unauthorized" } "404": { $ref: "#/components/responses/NotFound" } "422": { $ref: "#/components/responses/Validation" } /reseller/{resellerTeamId}/managed-teams/{managedTeamId}: get: tags: [Reseller] summary: Get a specific managed team description: Get details for a specific managed team. operationId: getManagedTeam parameters: - $ref: "#/components/parameters/ResellerTeamId" - $ref: "#/components/parameters/ManagedTeamId" responses: "200": description: Managed team details content: application/json: schema: $ref: "#/components/schemas/ManagedTeamResponse" examples: success: value: data: id: 12345 name: Client Company timezone: UTC created_at: "2024-01-15T10:30:00.000000Z" monitors_count: 5 "401": { $ref: "#/components/responses/Unauthorized" } "404": { $ref: "#/components/responses/NotFound" } put: tags: [Reseller] summary: Update a managed team description: Update the name, timezone, or default uptime check location for a managed team. operationId: updateManagedTeam parameters: - $ref: "#/components/parameters/ResellerTeamId" - $ref: "#/components/parameters/ManagedTeamId" requestBody: required: true content: application/json: schema: $ref: "#/components/schemas/UpdateManagedTeamRequest" examples: basic: value: name: Updated Client Company timezone: Europe/Brussels default_uptime_check_location: paris responses: "200": description: Managed team updated content: application/json: schema: $ref: "#/components/schemas/ManagedTeamResponse" examples: success: value: data: id: 12345 name: Updated Client Company timezone: Europe/Brussels created_at: "2024-01-15T10:30:00.000000Z" monitors_count: 5 "401": { $ref: "#/components/responses/Unauthorized" } "404": { $ref: "#/components/responses/NotFound" } "422": { $ref: "#/components/responses/Validation" } delete: tags: [Reseller] summary: Delete a managed team description: Delete a managed team and all its associated data. This action cannot be undone. All monitors will be deleted, all users will be detached, and all pending invitations will be revoked. operationId: deleteManagedTeam parameters: - $ref: "#/components/parameters/ResellerTeamId" - $ref: "#/components/parameters/ManagedTeamId" responses: "204": { $ref: "#/components/responses/NoContent" } "401": { $ref: "#/components/responses/Unauthorized" } "404": { $ref: "#/components/responses/NotFound" } /reseller/{resellerTeamId}/managed-teams/{managedTeamId}/decouple: post: tags: [Reseller] summary: Decouple a managed team description: Remove the reseller relationship from a managed team, making it independent. The team owner will receive an email notification. The team will retain all its configuration and monitors, but monitoring will stop until they subscribe to their own plan. operationId: decoupleManagedTeam parameters: - $ref: "#/components/parameters/ResellerTeamId" - $ref: "#/components/parameters/ManagedTeamId" responses: "200": description: Team successfully decoupled content: application/json: schema: $ref: "#/components/schemas/DecoupleTeamResponse" examples: success: value: message: Team successfully decoupled from reseller. "401": { $ref: "#/components/responses/Unauthorized" } "404": { $ref: "#/components/responses/NotFound" } /reseller/{resellerTeamId}/managed-teams/{managedTeamId}/users: post: tags: [Reseller] summary: Add a user to a managed team description: | Add a user to a managed team. If a user with the given email already exists in the system, they will be added to the team. User roles: - `admin` - Can perform any action - `member` - Can perform all actions except team management - `guest` - Can perform all member actions except creating, updating, or deleting monitors operationId: addUserToManagedTeam parameters: - $ref: "#/components/parameters/ResellerTeamId" - $ref: "#/components/parameters/ManagedTeamId" requestBody: required: true content: application/json: schema: $ref: "#/components/schemas/AddUserToManagedTeamRequest" examples: guest: value: email: user@clientcompany.com name: Jane Smith role: guest admin: value: email: admin@clientcompany.com name: John Admin role: admin responses: "200": description: User added to team content: application/json: schema: $ref: "#/components/schemas/ManagedTeamUserResponse" examples: success: value: data: id: 98765 name: Jane Smith email: user@clientcompany.com current_team_id: 12345 profile_photo_path: null profile_photo_url: https://www.gravatar.com/avatar/... created_at: "2024-01-25T11:00:00.000000Z" updated_at: "2024-01-25T11:00:00.000000Z" "401": { $ref: "#/components/responses/Unauthorized" } "404": { $ref: "#/components/responses/NotFound" } "422": { $ref: "#/components/responses/Validation" } /reseller/{resellerTeamId}/managed-teams/{managedTeamId}/users/{userId}/generate-login-link: post: tags: [Reseller] summary: Generate login link for managed team user description: Generate a secure, time-limited login link for a user of a managed team. The link will be valid for 5 minutes and automatically log the user into their managed team context. operationId: generateLoginLinkForManagedTeamUser parameters: - $ref: "#/components/parameters/ResellerTeamId" - $ref: "#/components/parameters/ManagedTeamId" - $ref: "#/components/parameters/UserId" responses: "200": description: Login link generated content: application/json: schema: $ref: "#/components/schemas/LoginLinkResponse" examples: success: value: login_url: https://ohdear.app/reseller-login/98765/12345?expires=1640995200&signature=abc123... valid_until: "2025-01-01 12:05:00" "401": { $ref: "#/components/responses/Unauthorized" } "404": { $ref: "#/components/responses/NotFound" } # --- Port Scanning --- /monitors/{monitorId}/ports-history-items: get: tags: [Ports] summary: List port scan history description: Retrieve port scan history items for a monitor. Results are sorted in reverse chronological order. operationId: listPortsHistoryItems parameters: - $ref: "#/components/parameters/MonitorId" - $ref: "#/components/parameters/FilterCreatedAt" responses: "200": description: Port scan history items content: application/json: schema: type: object properties: data: type: array items: $ref: "#/components/schemas/PortScanResult" "401": { $ref: "#/components/responses/Unauthorized" } "404": { $ref: "#/components/responses/NotFound" } /monitors/{monitorId}/ports-history-items/{itemId}: get: tags: [Ports] summary: Get a specific port scan result description: Retrieve a specific port scan history item by its ID. operationId: getPortsHistoryItem parameters: - $ref: "#/components/parameters/MonitorId" - $ref: "#/components/parameters/PortsHistoryItemId" responses: "200": description: Port scan result content: application/json: schema: $ref: "#/components/schemas/PortScanResult" "401": { $ref: "#/components/responses/Unauthorized" } "404": { $ref: "#/components/responses/NotFound" } # --- DNS Blocklist --- /monitors/{monitorId}/dns-blocklist-history-items: get: tags: [DNS Blocklist] summary: List DNS blocklist history description: Retrieve DNS blocklist check history items for a monitor. Results are sorted in reverse chronological order. operationId: listDnsBlocklistHistoryItems parameters: - $ref: "#/components/parameters/MonitorId" - $ref: "#/components/parameters/FilterCreatedAt" responses: "200": description: DNS blocklist history items content: application/json: schema: type: object properties: data: type: array items: $ref: "#/components/schemas/DnsBlocklistResult" "401": { $ref: "#/components/responses/Unauthorized" } "404": { $ref: "#/components/responses/NotFound" } /monitors/{monitorId}/dns-blocklist-history-items/{itemId}: get: tags: [DNS Blocklist] summary: Get a specific DNS blocklist result description: Retrieve a specific DNS blocklist history item by its ID. operationId: getDnsBlocklistHistoryItem parameters: - $ref: "#/components/parameters/MonitorId" - $ref: "#/components/parameters/DnsBlocklistHistoryItemId" responses: "200": description: DNS blocklist result content: application/json: schema: $ref: "#/components/schemas/DnsBlocklistResult" "401": { $ref: "#/components/responses/Unauthorized" } "404": { $ref: "#/components/responses/NotFound" } # --- Sitemap --- /sitemap/{monitorId}: get: tags: [Sitemap] summary: Get sitemap check results description: > Retrieve the sitemap check results for a monitor. Returns results from the latest completed run by default. Pass `run_id` to fetch results from a specific past run (see check history endpoint). operationId: getSitemapResults parameters: - $ref: "#/components/parameters/MonitorId" - $ref: "#/components/parameters/RunId" responses: "200": description: Sitemap check results content: application/json: schema: type: object properties: checkUrl: { type: string, format: uri } totalIssuesCount: { type: integer } totalUrlCount: { type: integer } hasIssues: { type: boolean } issues: type: array items: { type: object, additionalProperties: true } sitemapIndexes: type: array items: type: object properties: url: { type: string, format: uri } issues: type: array items: { type: object, additionalProperties: true } sitemaps: type: array items: type: object properties: url: { type: string, format: uri } urlCount: { type: integer } checkedReachabilityOfAllUrls: { type: boolean } issuesCount: { type: integer } issues: type: array items: { type: object, additionalProperties: true } run_id: type: ["integer", "null"] description: The ID of the run these results come from run_started_at: type: ["string", "null"] format: date-time description: When the run started (ISO 8601, UTC), or null run_ended_at: type: ["string", "null"] format: date-time description: When the run completed (ISO 8601, UTC) ohdear_url: type: ["string", "null"] format: uri description: Direct link to this run's report page in the Oh Dear dashboard documentation_url: type: string format: uri description: Link to the documentation page for sitemap monitoring "401": { $ref: "#/components/responses/Unauthorized" } "404": { $ref: "#/components/responses/NotFound" } "422": { $ref: "#/components/responses/Validation" } # --- Public Metrics --- /public-metrics: get: tags: [Public Metrics] summary: Get public metrics description: Retrieve public API metrics (run count, notification count). This endpoint does not require authentication. operationId: getPublicMetrics security: [] responses: "200": description: Public metrics content: application/json: schema: $ref: "#/components/schemas/PublicMetrics" examples: success: value: run_count: 123456789 notification_count: 98765432 "429": { $ref: "#/components/responses/TooManyRequests" } # --- Recurring Maintenance Periods --- /monitors/{monitorId}/recurring-maintenance-periods: get: tags: [Recurring Maintenance Periods] summary: List recurring maintenance periods for a monitor description: Retrieve all recurring maintenance periods associated with a specific monitor. operationId: listRecurringMaintenancePeriods parameters: - $ref: "#/components/parameters/MonitorId" responses: "200": description: Recurring maintenance periods content: application/json: schema: type: object properties: data: type: array items: $ref: "#/components/schemas/RecurringMaintenancePeriod" "401": { $ref: "#/components/responses/Unauthorized" } "404": { $ref: "#/components/responses/NotFound" } /recurring-maintenance-periods/{recurringMaintenancePeriodId}: get: tags: [Recurring Maintenance Periods] summary: Get a recurring maintenance period description: Retrieve a specific recurring maintenance period by its ID. operationId: getRecurringMaintenancePeriod parameters: - $ref: "#/components/parameters/RecurringMaintenancePeriodId" responses: "200": description: Recurring maintenance period content: application/json: schema: $ref: "#/components/schemas/RecurringMaintenancePeriod" "401": { $ref: "#/components/responses/Unauthorized" } "404": { $ref: "#/components/responses/NotFound" } put: tags: [Recurring Maintenance Periods] summary: Update a recurring maintenance period description: Update an existing recurring maintenance period. operationId: updateRecurringMaintenancePeriod parameters: - $ref: "#/components/parameters/RecurringMaintenancePeriodId" requestBody: required: true content: application/json: schema: $ref: "#/components/schemas/UpdateRecurringMaintenancePeriodRequest" responses: "200": description: Recurring maintenance period updated content: application/json: schema: $ref: "#/components/schemas/RecurringMaintenancePeriod" "401": { $ref: "#/components/responses/Unauthorized" } "404": { $ref: "#/components/responses/NotFound" } "422": { $ref: "#/components/responses/Validation" } delete: tags: [Recurring Maintenance Periods] summary: Delete a recurring maintenance period description: Delete a recurring maintenance period. Optionally delete all future periods generated from this recurrence. operationId: deleteRecurringMaintenancePeriod parameters: - $ref: "#/components/parameters/RecurringMaintenancePeriodId" - name: delete_future_periods in: query description: Whether to also delete all future maintenance periods generated from this recurrence schema: { type: boolean, default: false } responses: "204": { $ref: "#/components/responses/NoContent" } "401": { $ref: "#/components/responses/Unauthorized" } "404": { $ref: "#/components/responses/NotFound" } /recurring-maintenance-periods: post: tags: [Recurring Maintenance Periods] summary: Create a recurring maintenance period description: Create a new recurring maintenance period for a monitor. operationId: createRecurringMaintenancePeriod requestBody: required: true content: application/json: schema: $ref: "#/components/schemas/CreateRecurringMaintenancePeriodRequest" responses: "201": description: Recurring maintenance period created content: application/json: schema: $ref: "#/components/schemas/RecurringMaintenancePeriod" "401": { $ref: "#/components/responses/Unauthorized" } "403": { $ref: "#/components/responses/Forbidden" } "422": { $ref: "#/components/responses/Validation" } # --- Get Monitor by URL --- /monitors/url/{monitorUrl}: get: tags: [Monitors] summary: Get a monitor by URL description: Retrieve a monitor by its URL-encoded URL. operationId: getMonitorByUrl parameters: - name: monitorUrl description: The URL-encoded URL of the monitor in: path required: true schema: { type: string } responses: "200": description: Monitor content: application/json: schema: $ref: "#/components/schemas/Monitor" "401": { $ref: "#/components/responses/Unauthorized" } "404": { $ref: "#/components/responses/NotFound" } # --- DNS History Single Item --- /monitors/{monitorId}/dns-history-items/{dnsHistoryItemId}: get: tags: [DNS] summary: Get a specific DNS history item description: Retrieve a specific DNS history item by its ID. operationId: getDnsHistoryItem parameters: - $ref: "#/components/parameters/MonitorId" - $ref: "#/components/parameters/DnsHistoryItemId" responses: "200": description: DNS history item content: application/json: schema: $ref: "#/components/schemas/DnsHistoryItem" "401": { $ref: "#/components/responses/Unauthorized" } "404": { $ref: "#/components/responses/NotFound" } # --- Status Page Update Templates --- /status-page-update-templates: get: tags: [Status Page Update Templates] summary: List status page update templates description: Retrieve all status page update templates for your teams. operationId: listStatusPageUpdateTemplates responses: "200": description: List of status page update templates content: application/json: schema: type: object properties: data: type: array items: $ref: "#/components/schemas/StatusPageUpdateTemplate" "401": { $ref: "#/components/responses/Unauthorized" } "403": { $ref: "#/components/responses/Forbidden" } post: tags: [Status Page Update Templates] summary: Create a status page update template description: Create a new reusable template for status page updates. operationId: createStatusPageUpdateTemplate requestBody: required: true content: application/json: schema: $ref: "#/components/schemas/CreateStatusPageUpdateTemplateRequest" responses: "201": description: Template created content: application/json: schema: $ref: "#/components/schemas/StatusPageUpdateTemplate" "401": { $ref: "#/components/responses/Unauthorized" } "403": { $ref: "#/components/responses/Forbidden" } "404": { $ref: "#/components/responses/NotFound" } "422": { $ref: "#/components/responses/Validation" } /status-page-update-templates/{statusPageUpdateTemplateId}: put: tags: [Status Page Update Templates] summary: Update a status page update template description: Update an existing status page update template. operationId: updateStatusPageUpdateTemplate parameters: - $ref: "#/components/parameters/StatusPageUpdateTemplateId" requestBody: required: true content: application/json: schema: $ref: "#/components/schemas/UpdateStatusPageUpdateTemplateRequest" responses: "200": description: Template updated content: application/json: schema: $ref: "#/components/schemas/StatusPageUpdateTemplate" "401": { $ref: "#/components/responses/Unauthorized" } "404": { $ref: "#/components/responses/NotFound" } "422": { $ref: "#/components/responses/Validation" } delete: tags: [Status Page Update Templates] summary: Delete a status page update template description: Delete a status page update template. This action is irreversible. operationId: deleteStatusPageUpdateTemplate parameters: - $ref: "#/components/parameters/StatusPageUpdateTemplateId" responses: "204": { $ref: "#/components/responses/NoContent" } "401": { $ref: "#/components/responses/Unauthorized" } "404": { $ref: "#/components/responses/NotFound" } components: securitySchemes: bearerAuth: type: http scheme: bearer bearerFormat: JWT description: Use your API token as Bearer token. parameters: MonitorId: name: monitorId description: ID of the monitor in: path required: true schema: { type: integer, format: int64, minimum: 1 } StatusPageId: name: statusPageId description: ID of the status page in: path required: true schema: { type: integer, format: int64, minimum: 1 } CheckId: name: checkId description: ID of the check in: path required: true schema: { type: integer, format: int64, minimum: 1 } CronCheckId: name: cronCheckId description: ID of the cron check in: path required: true schema: { type: integer, format: int64, minimum: 1 } CronCheckDefinitionId: name: cronCheckDefinitionId description: ID of the cron check definition in: path required: true schema: { type: integer, format: int64, minimum: 1 } ApplicationHealthCheckId: name: applicationHealthCheckId description: ID of the application health check in: path required: true schema: { type: integer, format: int64, minimum: 1 } LighthouseReportId: name: lighthouseReportId description: ID of the Lighthouse report in: path required: true schema: { type: integer, format: int64, minimum: 1 } AiResponseId: name: aiResponseId description: ID of the AI response in: path required: true schema: { type: integer, format: int64, minimum: 1 } PageNumber: name: page[number] description: The page number to retrieve in: query schema: { type: integer, minimum: 1, default: 1, format: int32 } PageSize: name: page[size] description: The number of items to retrieve per page in: query schema: { type: integer, minimum: 1, maximum: 200, default: 200 } FilterStartedAt: name: filter[started_at] in: query description: Start timestamp (format YYYYMMDDHHMMSS) schema: { type: string, pattern: "^[0-9]{14}$" } FilterEndedAt: name: filter[ended_at] in: query description: End timestamp (format YYYYMMDDHHMMSS) schema: { type: string, pattern: "^[0-9]{14}$" } FilterStart: name: filter[start] in: query description: Start timestamp (format YYYYMMDDHHMMSS) schema: { type: string, pattern: "^[0-9]{14}$" } FilterEnd: name: filter[end] in: query description: End timestamp (format YYYYMMDDHHMMSS) schema: { type: string, pattern: "^[0-9]{14}$" } FilterGroupBy: name: filter[group_by] in: query description: Grouping granularity schema: type: string enum: [minute, hour, day, week, month] TeamId: name: teamId description: ID of the team in: path required: true schema: { type: integer } DestinationId: name: destinationId description: ID of the notification destination in: path required: true schema: { type: integer } TagId: name: tagId description: ID of the tag in: path required: true schema: { type: integer } TagGroupId: name: tagGroupId description: ID of the tag group in: path required: true schema: { type: integer } ResellerTeamId: name: resellerTeamId description: ID of the reseller team in: path required: true schema: { type: integer } ManagedTeamId: name: managedTeamId description: ID of the managed team in: path required: true schema: { type: integer } UserId: name: userId description: ID of the user in: path required: true schema: { type: integer } FilterName: name: filter[name] description: Filter by name (partial match) in: query schema: { type: string } FilterTimezone: name: filter[timezone] description: Filter by timezone (exact match) in: query schema: { type: string } Sort: name: sort description: Sort field in: query schema: type: string enum: [name, created_at] default: name Page: name: page description: Page number for pagination in: query schema: { type: integer, minimum: 1, default: 1 } FilterCreatedAt: name: filter[created_at] in: query description: Filter by creation timestamp (format YmdHis, e.g. 20240101120000) schema: { type: string, pattern: "^[0-9]{14}$" } RecurringMaintenancePeriodId: name: recurringMaintenancePeriodId description: ID of the recurring maintenance period in: path required: true schema: { type: integer, format: int64, minimum: 1 } StatusPageUpdateTemplateId: name: statusPageUpdateTemplateId description: ID of the status page update template in: path required: true schema: { type: integer, format: int64, minimum: 1 } PortsHistoryItemId: name: itemId description: ID of the port scan history item in: path required: true schema: { type: integer, format: int64, minimum: 1 } DnsBlocklistHistoryItemId: name: itemId description: ID of the DNS blocklist history item in: path required: true schema: { type: integer, format: int64, minimum: 1 } DnsHistoryItemId: name: dnsHistoryItemId description: ID of the DNS history item in: path required: true schema: { type: integer, format: int64, minimum: 1 } RunId: name: run_id description: Return results from a specific run instead of the latest. Get run IDs from the check history endpoint. in: query schema: { type: integer, format: int64, minimum: 1 } FilterStartedAfter: name: filter[started_after] description: Only return runs started at or after this timestamp (format YmdHis in UTC, e.g. 20260315000000) in: query schema: { type: string, pattern: "^[0-9]{14}$" } FilterStartedBefore: name: filter[started_before] description: Only return runs started at or before this timestamp (format YmdHis in UTC, e.g. 20260320000000) in: query schema: { type: string, pattern: "^[0-9]{14}$" } FilterResult: name: filter[result] description: Filter by run result in: query schema: type: string enum: [succeeded, warning, failed] MaintenancePeriodId: name: maintenancePeriodId description: ID of the maintenance period in: path required: true schema: { type: integer, format: int64, minimum: 1 } schemas: Links: type: object description: Pagination links properties: first: { type: ["string", "null"], format: uri } last: { type: ["string", "null"], format: uri } prev: { type: ["string", "null"], format: uri } next: { type: ["string", "null"], format: uri } User: type: object description: A user in the system properties: id: { type: integer } name: { type: string } email: { type: string, format: email } photo_url: { type: string, format: uri } teams: type: array items: type: object properties: id: { type: integer } name: { type: string } timezone: { type: string } created_at: { type: string, format: date-time } examples: - id: 1 name: John Doe email: john.doe@example.com photo_url: https://example.com/photos/john.jpg teams: - id: 12345 name: Awesome Team timezone: Europe/Brussels created_at: "2019-09-13T13:06:51Z" Monitor: type: object description: A monitor properties: id: { type: integer } team_id: { type: integer } type: type: string enum: [http, ping, tcp, ai] url: { type: string } uses_https: { type: boolean } sort_url: { type: string } label: { type: string } group_name: { type: string } tags: type: array items: { type: string } description: type: ["string", "null"] notes: type: ["string", "null"] latest_run_date: type: ["string", "null"] summarized_check_result: type: string description: >- The aggregated result across all checks for this monitor. `warning` indicates at least one check has a partial connectivity issue but none have fully failed. For uptime checks, this means the primary checker location failed but the secondary location confirmed the monitor is still reachable. Warnings count as online for uptime percentage calculations. Priority order: failed > warning > succeeded > pending. enum: [pending, succeeded, warning, failed, "errored-or-timed-out"] checks: type: array items: $ref: "#/components/schemas/Check" uptime_check_settings: $ref: "#/components/schemas/UptimeCheckSettings" certificate_health_check_settings: type: ["object", "null"] properties: expires_soon_threshold_in_days: type: ["integer", "null"] broken_links_check_settings: type: ["object", "null"] properties: whitelisted_urls: type: array items: { type: string } check_include_external_links: { type: boolean } types: type: array items: { type: string } do_not_crawl_urls: type: array items: { type: string } force_crawl_urls: type: array items: { type: string } new_links_only: { type: boolean } dns_check_settings: type: ["object", "null"] properties: extra_cnames: type: array items: { type: string } monitor_main_domain: { type: boolean } ignored_record_types: type: array items: { type: string } check_nameservers_in_sync: { type: boolean } lighthouse_check_settings: type: ["object", "null"] properties: continent: { type: string } device_emulation: { type: string } notification_settings: type: ["object", "null"] http_client_headers: type: array items: { $ref: "#/components/schemas/NameValuePair" } application_health_check_settings: type: ["object", "null"] properties: result_url: type: ["string", "null"] secret: { type: string } frequency_value: { type: integer, minimum: 1, maximum: 1440 } frequency_unit: { type: string, enum: [minute] } headers: type: array items: { $ref: "#/components/schemas/NameValuePair" } domain_check_settings: type: ["object", "null"] properties: not_supported_reason: type: ["string", "null"] expires_soon_threshold_in_days: type: ["integer", "null"] performance_check_settings: type: ["object", "null"] properties: threshold_in_ms: { type: integer } change_percentage: { type: integer } sitemap_check_settings: type: ["object", "null"] properties: path: { type: string } speed: { type: string } ports_check_settings: type: ["object", "null"] properties: expected_open_ports: type: array items: { type: integer } expected_closed_ports: type: array items: { type: integer } timeout_per_port_ms: { type: integer } failure_threshold: { type: integer } continent: { type: string } dns_blocklist_check_settings: type: ["object", "null"] properties: use_all_blocklists: { type: boolean } enabled_blocklists: type: array items: { type: string } ai_check_settings: type: ["object", "null"] properties: prompt: { type: string } frequency_unit: { type: string } frequency_value: { type: integer } suppress_repeated_success_notifications: { type: boolean } throttle_failed_interval_unit: { type: string } throttle_failed_interval_value: { type: integer } html_stripping_level: { type: string } location: { type: string } crawler_headers: type: ["array", "null"] items: { $ref: "#/components/schemas/NameValuePair" } send_report_to_emails: type: ["array", "null"] items: { type: string, format: email } include_check_types_in_report: type: ["array", "null"] items: { $ref: "#/components/schemas/CheckType" } badge_id: { type: string } marked_for_deletion_at: type: ["string", "null"] created_at: { type: string } updated_at: { type: string } CreateMonitorRequest: type: object description: Request to create a new monitor required: [url, team_id, type] properties: url: { type: string, format: uri } team_id: { type: integer } type: { type: string, enum: [http, ping, tcp, ai] } checks: type: array description: >- The checks to enable on the new monitor. Leave it out to enable the default checks for the monitor type. The `performance` check follows the `uptime` check: it's enabled whenever `uptime` is, so you don't need to list it. Listing `performance` without `uptime` leaves it disabled. items: { $ref: "#/components/schemas/CheckType" } group_name: { type: string } friendly_name: type: string description: >- A custom display name for the monitor. Returned as `label` on the monitor (which falls back to `sort_url` when no friendly name is set). tags: type: array items: { type: string } notes: { type: string } description: { type: string } uptime_check_settings: $ref: "#/components/schemas/UptimeCheckSettings" performance_check_settings: type: object properties: threshold_in_ms: { type: integer } change_percentage: { type: integer } crawler_settings: type: object properties: headers: type: array items: { $ref: "#/components/schemas/NameValuePair" } broken_links_check_settings: type: object properties: whitelisted_urls: type: array items: { type: string } check_include_external_links: { type: boolean } types: type: array items: { type: string } force_crawl_urls: type: array items: { type: string } new_links_only: { type: boolean } sitemap_check_settings: type: object properties: path: { type: string } speed: type: string enum: [default, fast, slow, slowest, fastest] application_health_check_settings: type: object properties: result_url: { type: string, format: uri } frequency_value: { type: integer, minimum: 1, maximum: 1440 } frequency_unit: { type: string, enum: [minute] } headers: type: array items: { $ref: "#/components/schemas/NameValuePair" } certificate_health_check_settings: type: object properties: expires_soon_threshold_in_days: { type: integer } dns_check_settings: type: object properties: extra_cnames: type: array items: { type: string } monitor_main_domain: { type: boolean } ignored_record_types: type: array items: { type: string } check_nameservers_in_sync: { type: boolean } domain_check_settings: type: object properties: expires_soon_threshold_in_days: { type: integer } lighthouse_check_settings: type: object properties: continent: { type: string } device_emulation: { type: string } ports_check_settings: type: object properties: expected_open_ports: type: array items: { type: integer } expected_closed_ports: type: array items: { type: integer } timeout_per_port_ms: { type: integer } continent: { type: string } send_report_to_emails: type: array items: { type: string, format: email } include_check_types_in_report: type: array items: { $ref: "#/components/schemas/CheckType" } UpdateMonitorRequest: type: object description: Request to update an existing monitor properties: url: { type: string, format: uri } checks: type: array description: >- The checks to keep enabled on the monitor. Checks you leave out are disabled. The `performance` check follows the `uptime` check: it's enabled whenever `uptime` is, so you don't need to list it. Listing `performance` without `uptime` leaves it disabled. items: { $ref: "#/components/schemas/CheckType" } group_name: { type: string } friendly_name: type: string description: >- A custom display name for the monitor. Returned as `label` on the monitor (which falls back to `sort_url` when no friendly name is set). tags: type: array items: { type: string } notes: { type: string } description: { type: string } uptime_check_settings: $ref: "#/components/schemas/UptimeCheckSettings" performance_check_settings: type: object properties: threshold_in_ms: { type: integer } change_percentage: { type: integer } broken_links_check_settings: type: object properties: check_include_external_links: { type: boolean } types: type: array items: { type: string } whitelisted_urls: type: array items: { type: string, format: uri } respect_robots: { type: boolean } do_not_crawl_urls: type: array items: { type: string } force_crawl_urls: type: array items: { type: string } new_links_only: { type: boolean } sitemap_check_settings: type: object properties: path: { type: string } speed: type: string enum: [default, fast, slow, slowest, fastest] application_health_check_settings: type: object properties: result_url: { type: string, format: uri } secret: type: ["string", "null"] frequency_value: { type: integer, minimum: 1, maximum: 1440 } frequency_unit: { type: string, enum: [minute] } headers: type: array items: { $ref: "#/components/schemas/NameValuePair" } certificate_health_check_settings: type: object properties: expires_soon_threshold_in_days: { type: integer } dns_check_settings: type: object properties: check_nameservers_in_sync: { type: boolean } monitor_main_domain: { type: boolean } extra_cnames: type: array items: { type: string } ignored_record_types: type: array items: { type: string } domain_check_settings: type: object properties: expires_soon_threshold_in_days: { type: integer } lighthouse_check_settings: type: object properties: continent: { type: string } cpu_slowdown_modifier: { type: number } device_emulation: { type: string } notification_settings: type: object additionalProperties: true http_client_headers: type: array items: { $ref: "#/components/schemas/NameValuePair" } ports_check_settings: type: object properties: expected_open_ports: type: array items: { type: integer } expected_closed_ports: type: array items: { type: integer } timeout_per_port_ms: { type: integer } continent: { type: string } dns_blocklist_check_settings: type: object properties: use_all_blocklists: { type: boolean } enabled_blocklists: type: array items: { type: string } ai_check_settings: type: object properties: location: { type: string } prompt: { type: string } html_stripping_level: { type: string } crawler_settings: type: object properties: headers: type: array items: { $ref: "#/components/schemas/NameValuePair" } crawler_headers: type: array items: { $ref: "#/components/schemas/NameValuePair" } send_report_to_emails: type: array items: { type: string, format: email } include_check_types_in_report: type: array items: { $ref: "#/components/schemas/CheckType" } UptimeCheckSettings: type: object description: > Settings for uptime checks. Properties vary by monitor type: HTTP monitors use location, look_for_string, http_verb, etc. Ping monitors use location, ttl, count, packet_size_in_bytes, etc. TCP monitors use location, tcp_send_string, timeout_in_ms, etc. properties: location: { type: string } # HTTP monitor settings look_for_string: type: ["string", "null"] absent_string: type: ["string", "null"] expected_response_headers: type: array items: { $ref: "#/components/schemas/ExpectedHeader" } response_body_assertions: type: ["array", "null"] maxItems: 10 description: >- Assertions run against the JSON response body. If any assertion fails, the monitor is considered down. Only evaluated when the response is valid JSON and smaller than 2 MB. items: { $ref: "#/components/schemas/ResponseBodyAssertion" } failed_notification_threshold: { type: integer } http_verb: { type: string } payload: type: array items: { $ref: "#/components/schemas/NameValuePair" } raw_payload: type: ["string", "null"] description: >- A raw JSON body, sent verbatim, so nested objects and non-string types survive. Must be valid JSON. Takes precedence over payload when both are set. timeout: { type: integer } frequency_value: type: ["integer", "null"] minimum: 1 maximum: 60 description: How often the check runs, expressed in frequency_unit. A failing uptime check is always retried every minute. frequency_unit: type: ["string", "null"] enum: [minute, null] valid_status_codes: type: array items: { type: string } max_redirect_count: { type: integer } expected_final_redirect_url: type: ["string", "null"] http_client_headers: type: array items: { $ref: "#/components/schemas/NameValuePair" } # Ping monitor settings ttl: { type: integer } count: { type: integer } packet_size_in_bytes: { type: integer } acceptable_packet_loss_percentage: { type: number } acceptable_average_response_time_in_ms: { type: integer } timeout_in_seconds: { type: integer } interval_in_seconds: { type: integer } # TCP monitor settings tcp_send_string: { type: string } timeout_in_ms: { type: integer } look_for_string_in_welcome_message: { type: string } look_for_string_in_send_string_response: { type: string } ResponseBodyAssertion: type: object description: An assertion on a value in the JSON response body properties: path: type: string description: The field to read, in dot notation. Array items are addressed by index, and `*` spreads across every item in a list (e.g. `data.items.*.id`). operator: type: string enum: ["equals", "not equals", "contains", "greater than", "less than", "exists", "does not exist"] value: type: ["string", "null"] description: The expected value. Not needed for the exists and does not exist operators. ExpectedHeader: type: object description: Expected HTTP header properties: name: { type: string } condition: { type: string } value: { type: string } NameValuePair: type: object description: A simple name/value pair properties: name: { type: string } value: { type: string } Check: type: object description: A check associated with a monitor properties: id: { type: integer } type: $ref: "#/components/schemas/CheckType" label: { type: string } enabled: { type: boolean } latest_run_ended_at: type: ["string", "null"] latest_run_result: type: string description: >- The result of the most recent check run. `warning` indicates the primary checker location failed but the secondary location confirmed the monitor is still reachable (partial connectivity issue). Warnings count as online for uptime percentage calculations and do not create downtime periods. enum: [pending, succeeded, warning, failed, "errored-or-timed-out"] summary: type: ["string", "null"] settings: type: object description: Check-specific settings average_response_time_in_ms: type: ["number", "null"] description: Only present on performance checks -- average response time over the past 15 minutes in milliseconds active_snooze: type: ["object", "null"] properties: id: { type: integer } starts_at: { type: string } ends_at: { type: string } snoozed_by: { type: string } unsnoozed_by: type: ["string", "null"] source: { type: string } created_at: { type: string } CheckType: type: string description: The type of check enum: [ uptime, performance, certificate_health, broken_links, mixed_content, lighthouse, cron, application_health, sitemap, dns, domain, ai, ports, dns_blocklist, ] CheckEnableToggle: type: object description: Request to enable or disable a check properties: id: { type: integer } type: { $ref: "#/components/schemas/CheckType" } enabled: { type: boolean } CheckRunRequest: type: object description: Request to run a specific check immediately properties: httpClientHeaders: type: array description: Custom HTTP headers for this specific run (uptime checks only, max 5 headers) items: { $ref: "#/components/schemas/NameValuePair" } CheckRun: type: object description: A historical check run record properties: id: { type: integer, description: Unique identifier for this run } check_id: { type: integer, description: The ID of the check this run belongs to } check_type: { $ref: "#/components/schemas/CheckType" } result: type: string description: The result of this run enum: [succeeded, warning, failed] started_at: type: ["string", "null"] format: date-time description: When the run started (ISO 8601, UTC), or null if not recorded ended_at: type: string format: date-time description: When the run completed (ISO 8601, UTC) ohdear_url: type: string format: uri description: Direct link to this run's report page in the Oh Dear dashboard CheckRunsResponse: type: object description: Paginated list of historical check runs properties: data: type: array items: { $ref: "#/components/schemas/CheckRun" } links: allOf: - $ref: "#/components/schemas/Links" - type: object properties: documentation_url: type: string format: uri description: Link to the documentation page for this check type meta: { type: object, additionalProperties: true } RunMetadata: type: object description: Metadata about which run the results come from properties: run_id: type: ["integer", "null"] description: The ID of the run run_started_at: type: ["string", "null"] format: date-time description: When the run started (ISO 8601, UTC), or null run_ended_at: type: ["string", "null"] format: date-time description: When the run completed (ISO 8601, UTC) ohdear_url: type: ["string", "null"] format: uri description: Direct link to this run's report page in the Oh Dear dashboard CheckSummary: type: object description: Summary of a check's latest run properties: result: type: ["string", "null"] description: >- The result of the check summary. `warning` indicates a partial connectivity issue where the primary checker location failed but the secondary location confirmed the monitor is still reachable. `null` when the check has not yet run. enum: [pending, succeeded, warning, failed, null] summary: { type: string } UptimePoint: type: object description: A point in time representing uptime metrics properties: datetime: { type: string } uptime_percentage: { type: number } DowntimeRecord: type: object description: A record of downtime properties: id: { type: integer } started_at: { type: string } ended_at: { type: string } notes_html: { type: string } notes_markdown: { type: string } PaginatedDowntime: description: Paginated downtime records type: object properties: data: type: array items: { $ref: "#/components/schemas/DowntimeRecord" } UptimeMetricsHttpPoint: type: object description: A point in time representing HTTP uptime metrics properties: dns_time_in_seconds: { type: number } tcp_time_in_seconds: { type: number } ssl_handshake_time_in_seconds: { type: number } remote_server_processing_time_in_seconds: { type: number } download_time_in_seconds: { type: number } total_time_in_seconds: { type: number } curl: type: object properties: namelookup_time: { type: number } connect_time: { type: number } appconnect_time: { type: number } starttransfer_time: { type: number } pretransfer_time: { type: number } redirect_time: { type: number } total_time: { type: number } header_size: { type: integer } size_download: { type: integer } speed_download: { type: integer } date: { type: string } UptimeMetricsHttpResponse: type: object description: Response containing HTTP uptime metrics properties: data: type: array items: { $ref: "#/components/schemas/UptimeMetricsHttpPoint" } UptimeMetricsPingPoint: type: object description: A point in time representing Ping uptime metrics properties: minimum_time_in_ms: { type: number } maximum_time_in_ms: { type: number } average_time_in_ms: { type: number } packet_loss_percentage: { type: number } uptime_percentage: { type: number } downtime_percentage: { type: number } uptime_seconds: { type: integer } downtime_seconds: { type: integer } date: { type: string } UptimeMetricsPingResponse: type: object description: Response containing Ping uptime metrics properties: data: type: array items: { $ref: "#/components/schemas/UptimeMetricsPingPoint" } UptimeMetricsTcpPoint: type: object description: A point in time representing TCP uptime metrics properties: time_to_connect_in_ms: { type: number } uptime_percentage: { type: number } downtime_percentage: { type: number } uptime_seconds: { type: integer } downtime_seconds: { type: integer } date: { type: string } UptimeMetricsTcpResponse: type: object description: Response containing TCP uptime metrics properties: data: type: array items: { $ref: "#/components/schemas/UptimeMetricsTcpPoint" } BrokenLinksResponse: type: object description: Response containing broken links found during a crawl run properties: data: type: array items: type: object properties: crawled_url: { type: string, format: uri } relative_crawled_url: { type: string } status_code: { type: integer } found_on_url: { type: string, format: uri } relative_found_on_url: { type: string } link_text: { type: string } type: type: string description: The kind of resource enum: [link, image, script, stylesheet, "og:image"] error_message: type: ["string", "null"] description: A description of the error when the request failed entirely (e.g. DNS resolution failure, connection timeout), or null when a status code was received internal: { type: boolean } meta: { $ref: "#/components/schemas/RunMetadata" } links: type: object properties: documentation_url: type: string format: uri description: Link to the documentation page for broken links CrawledUrlsSummaryResponse: type: object description: Summary counts of all URLs found during a crawl run properties: data: type: object properties: total: type: integer description: The total number of URLs crawled internal: type: integer description: URLs on the same domain as the monitor external: type: integer description: URLs pointing to other domains by_type: type: object description: Breakdown by resource type additionalProperties: { type: integer } meta: { $ref: "#/components/schemas/RunMetadata" } links: { type: object } CrawledUrlsDetailsResponse: type: object description: Paginated list of all URLs found during a crawl run properties: data: type: array items: type: object properties: crawled_url: { type: string, format: uri } relative_crawled_url: { type: string } status_code: { type: integer } found_on_url: { type: string, format: uri } relative_found_on_url: { type: string } link_text: { type: string } type: type: string enum: [link, image, script, stylesheet, "og:image"] error_message: type: ["string", "null"] internal: { type: boolean } meta: type: object properties: current_page: { type: integer } from: { type: ["integer", "null"] } last_page: { type: integer } per_page: { type: integer } to: { type: ["integer", "null"] } total: { type: integer } run_id: { type: ["integer", "null"] } run_started_at: { type: ["string", "null"], format: date-time } run_ended_at: { type: ["string", "null"], format: date-time } links: type: object properties: first: { type: string, format: uri } last: { type: string, format: uri } prev: { type: ["string", "null"], format: uri } next: { type: ["string", "null"], format: uri } MixedContentResponse: type: object description: Response containing mixed content found during a crawl run properties: data: type: array items: type: object properties: element_name: { type: string } mixed_content_url: { type: string } found_on_url: { type: string } meta: { $ref: "#/components/schemas/RunMetadata" } links: type: object properties: documentation_url: type: string format: uri description: Link to the documentation page for mixed content CertificateHealth: type: object description: Health details of a certificate check run properties: certificate_details: type: object properties: issuer: { type: string } valid_from: { type: string } valid_until: { type: string } certificate_checks: type: array items: type: object properties: type: { type: string } label: { type: string } passed: { type: boolean } certificate_chain_issuers: type: array items: { type: string } run_id: type: ["integer", "null"] description: The ID of the run these results come from run_started_at: type: ["string", "null"] format: date-time description: When the run started (ISO 8601, UTC), or null run_ended_at: type: ["string", "null"] format: date-time description: When the run completed (ISO 8601, UTC) ohdear_url: type: ["string", "null"] format: uri description: Direct link to this run's report page in the Oh Dear dashboard documentation_url: type: string format: uri description: Link to the documentation page for certificate health DetectedCertificate: type: object description: A detected SSL/TLS certificate for a monitor properties: id: { type: integer } monitor_id: { type: integer } fingerprint: { type: string } certificate_details: type: object properties: issuer: { type: string } domain: { type: string } additional_domains: type: array items: { type: string } valid_from: { type: string, format: date-time } valid_until: { type: string, format: date-time } days_until_expiration: { type: integer } signature_algorithm: { type: string } is_valid: { type: boolean } is_expired: { type: boolean } created_at: { type: string, format: date-time } updated_at: { type: string, format: date-time } PaginatedDetectedCertificates: type: object description: A paginated list of detected certificates properties: data: type: array items: { $ref: "#/components/schemas/DetectedCertificate" } links: type: object additionalProperties: type: ["object", "string", "null"] description: The `links` object contains URLs for navigating through the paginated results. The `first` and `last` properties provide links to the first and last pages, respectively. example: first: https://ohdear.app/api/monitors/1/certificates?page=1 last: https://ohdear.app/api/monitors/1/certificates?page=3 prev: null next: https://ohdear.app/api/monitors/1/certificates?page=2 meta: type: object properties: current_page: { type: integer, minimum: 1 } from: { type: integer, minimum: 1 } last_page: { type: integer, minimum: 1 } per_page: { type: integer, minimum: 1 } to: { type: integer, minimum: 1 } total: { type: integer, minimum: 0 } MaintenancePeriod: description: A maintenance period for a monitor type: object properties: id: { type: integer } monitor_id: oneOf: - type: integer - type: string name: type: ["string", "null"] starts_at: { type: string } ends_at: { type: string } MaintenancePeriodsResponse: description: A paginated list of maintenance periods type: object properties: data: type: array items: { $ref: "#/components/schemas/MaintenancePeriod" } CreateMaintenancePeriodRequest: description: Request to create a new maintenance period type: object required: [monitor_id, starts_at, ends_at] properties: monitor_id: { type: integer } starts_at: { type: string, description: "Start date and time in Y-m-d H:i format", } ends_at: { type: string, description: "End date and time in Y-m-d H:i format" } name: type: ["string", "null"] StatusPage: description: A status page for a monitor type: object properties: id: { type: integer } team: type: object properties: id: { type: integer } name: { type: string } title: { type: string } domain: { type: string } slug: { type: string } full_url: { type: string, format: uri } timezone: { type: string } summarized_status: { type: string, enum: [up, down, warning, unknown] } secret: type: ["string", "null"] badge_id: type: ["string", "null"] prevent_indexing: { type: boolean } add_hsts_header: { type: boolean } show_uptime_history: type: boolean description: Whether the uptime history bars are shown below each monitor uptime_history_days: type: integer enum: [30, 60, 90] description: How many days of uptime history the bars cover monitors: type: array items: type: object properties: id: { type: integer } url: { type: string } created_at: { type: string } updated_at: { type: string } StatusPageWithUpdates: description: A status page with its updates allOf: - $ref: "#/components/schemas/StatusPage" - type: object properties: updates: type: array items: $ref: "#/components/schemas/StatusPageUpdate" PaginatedStatusPages: description: A paginated list of status pages type: object properties: data: type: array items: { $ref: "#/components/schemas/StatusPage" } links: type: object additionalProperties: type: ["object", "string", "null"] meta: type: object properties: current_page: { type: integer } from: { type: integer } last_page: { type: integer } path: { type: string } per_page: { type: integer } to: { type: integer } total: { type: integer } CreateStatusPageRequest: description: Request to create a new status page type: object required: [team_id, title, monitors] properties: team_id: { type: integer } title: { type: string } monitors: type: array items: type: object required: [id, clickable] properties: id: { type: integer } clickable: { type: boolean } AddStatusPageMonitorsRequest: type: object description: Request to add monitors to a status page required: [monitors] properties: sync: { type: boolean } monitors: type: array items: type: object required: [id, clickable] properties: id: { type: integer } clickable: { type: boolean } StatusPageUpdatesResponse: type: object description: Represents a paginated list of status page updates properties: data: type: array items: $ref: "#/components/schemas/StatusPageUpdate" StatusPageUpdate: type: object description: A status page update properties: id: { type: integer } title: { type: string } text: { type: string } pinned: { type: boolean } severity: { type: string, enum: [info, warning, high, resolved, scheduled] } time: { type: string } status_page_url: { type: string, format: uri } CreateStatusPageUpdateRequest: type: object description: Request to create a new status page update required: [status_page_id, title, severity, time] properties: status_page_id: { type: integer } title: { type: string } text: { type: string } severity: { type: string, enum: [info, warning, high, resolved, scheduled] } time: { type: string, description: "UTC Y-m-d H:i" } pinned: { type: boolean } CronCheck: type: object description: Represents a cron check properties: id: { type: integer } uuid: { type: string } name: { type: string } type: { type: string, enum: [simple, cron] } description: { type: string } frequency_in_minutes: type: ["integer", "null"] grace_time_in_minutes: type: ["integer", "null"] cron_expression: type: ["string", "null"] server_timezone: type: ["string", "null"] ping_url: { type: string, format: uri } created_at: { type: string } latest_result: { type: string } latest_result_label: { type: string } latest_result_label_color: { type: string } latest_ping_at: { type: string } human_readable_latest_ping_at: { type: string } human_readable_cron_expression: type: ["string", "null"] active_snooze: type: ["object", "null"] properties: id: { type: integer } starts_at: { type: string } ends_at: { type: string } snoozed_by: { type: string } unsnoozed_by: type: ["string", "null"] source: { type: string } created_at: { type: string } ApplicationHealthCheck: type: object description: Represents an application health check properties: id: { type: integer } name: { type: string } label: { type: string } status: type: string enum: [ok, warning, failed, crashed, skipped] message: { type: string } short_summary: { type: string } meta: type: object additionalProperties: true latest_result: { type: string } latest_run_ended_at: type: ["string", "null"] detected_at: type: ["string", "null"] updated_at: type: ["string", "null"] active_snooze: type: ["object", "null"] properties: id: { type: integer } starts_at: { type: string } ends_at: { type: string } snoozed_by: { type: string } unsnoozed_by: type: ["string", "null"] source: { type: string } created_at: { type: string } CronChecksResponse: type: object description: Represents a response from a cron check request properties: data: type: array items: $ref: "#/components/schemas/CronCheck" PaginatedMonitors: type: object description: Paginated list of monitors properties: data: type: array items: $ref: "#/components/schemas/Monitor" links: $ref: "#/components/schemas/Links" meta: type: object properties: current_page: { type: integer } from: { type: integer } last_page: { type: integer } path: { type: string } per_page: { type: integer } to: { type: integer } total: { type: integer } NotificationChannel: type: string description: The notification channel type enum: [ mail, discord, googleChat, microsoftTeams, microsoftTeamsWorkflow, ntfy, opsgenie, pagerDuty, pushover, slack, slackApi, sms, telegram, webhook, ] NotificationDestination: type: object description: A notification destination configuration properties: id: { type: integer } label: type: ["string", "null"] team_id: { type: integer } channel: $ref: "#/components/schemas/NotificationChannel" destination: type: object description: Channel-specific destination configuration additionalProperties: true notification_types: type: array items: { type: string } enabled: type: boolean description: Whether the destination is currently active. A disabled destination keeps all its settings but sends no notifications until it is enabled again. disabled_reason: type: ["string", "null"] description: When Oh Dear disabled a destination automatically after repeated delivery failures, this explains why. It is null for active destinations and for destinations you disabled yourself. TeamNotificationDestination: type: object description: A team-level notification destination allOf: - $ref: "#/components/schemas/NotificationDestination" MonitorNotificationDestination: type: object description: A monitor-level notification destination properties: id: { type: integer } channel: $ref: "#/components/schemas/NotificationChannel" destination: type: object description: Channel-specific destination configuration additionalProperties: true notification_types: type: array items: { type: string } enabled: type: boolean description: Whether the destination is currently active. A disabled destination keeps all its settings but sends no notifications until it is enabled again. disabled_reason: type: ["string", "null"] description: When Oh Dear disabled a destination automatically after repeated delivery failures, this explains why. It is null for active destinations and for destinations you disabled yourself. TagNotificationDestination: type: object description: A tag-level notification destination properties: id: { type: integer } tag: type: object properties: id: { type: integer } name: { type: string } slug: { type: string } team_id: { type: integer } channel: $ref: "#/components/schemas/NotificationChannel" destination: type: object description: Channel-specific destination configuration additionalProperties: true notification_types: type: array items: { type: string } enabled: type: boolean description: Whether the destination is currently active. A disabled destination keeps all its settings but sends no notifications until it is enabled again. disabled_reason: type: ["string", "null"] description: When Oh Dear disabled a destination automatically after repeated delivery failures, this explains why. It is null for active destinations and for destinations you disabled yourself. TagGroupNotificationDestination: type: object description: A tag group-level notification destination properties: id: { type: integer } tagGroup: type: object properties: id: { type: integer } label: { type: string } team_id: { type: integer } team_name: { type: string } created_at: { type: string } updated_at: { type: string } tags: type: array items: $ref: "#/components/schemas/Tag" channel: $ref: "#/components/schemas/NotificationChannel" destination: type: object description: Channel-specific destination configuration additionalProperties: true notification_types: type: array items: { type: string } enabled: type: boolean description: Whether the destination is currently active. A disabled destination keeps all its settings but sends no notifications until it is enabled again. disabled_reason: type: ["string", "null"] description: When Oh Dear disabled a destination automatically after repeated delivery failures, this explains why. It is null for active destinations and for destinations you disabled yourself. Tag: type: object description: A tag for organizing monitors properties: id: type: ["integer", "null"] team_id: { type: integer } team_name: { type: string } name: { type: string } slug: { type: string } created_at: type: ["string", "null"] updated_at: type: ["string", "null"] sites: type: array items: { type: integer } TagGroup: type: object description: A tag group for combining multiple tags properties: id: { type: integer } label: { type: string } team_id: { type: integer } team_name: { type: string } created_at: { type: string } updated_at: { type: string } tags: type: array items: $ref: "#/components/schemas/Tag" ManagedTeam: type: object description: A team managed by a reseller properties: id: { type: integer } name: { type: string } timezone: { type: string } created_at: { type: string, format: date-time } monitors_count: { type: integer } ManagedTeamUser: type: object description: A user of a managed team properties: id: { type: integer } name: { type: string } email: { type: string, format: email } current_team_id: { type: integer } profile_photo_path: type: ["string", "null"] profile_photo_url: { type: string, format: uri } created_at: { type: string, format: date-time } updated_at: { type: string, format: date-time } ManagedTeamRole: type: string description: The role of a user in a managed team enum: [admin, member, guest] PaginatedManagedTeams: type: object description: Paginated list of managed teams properties: data: type: array items: $ref: "#/components/schemas/ManagedTeam" links: $ref: "#/components/schemas/Links" meta: type: object properties: current_page: { type: integer } from: { type: integer } last_page: { type: integer } per_page: { type: integer } to: { type: integer } total: { type: integer } ManagedTeamResponse: type: object description: Response containing a single managed team properties: data: $ref: "#/components/schemas/ManagedTeam" ManagedTeamUserResponse: type: object description: Response containing a single managed team user properties: data: $ref: "#/components/schemas/ManagedTeamUser" CreateManagedTeamRequest: type: object description: Request to create a new managed team required: [name] properties: name: type: string description: The name of the team timezone: type: string description: Team timezone (defaults to reseller's timezone) default_uptime_check_location: type: string description: Default uptime check location UpdateManagedTeamRequest: type: object description: Request to update a managed team properties: name: type: string description: The name of the team timezone: type: string description: Team timezone default_uptime_check_location: type: string description: Default uptime check location AddUserToManagedTeamRequest: type: object description: Request to add a user to a managed team required: [email, name, role] properties: email: type: string format: email description: Email address of the new user name: type: string description: Full name of the new user role: $ref: "#/components/schemas/ManagedTeamRole" LoginLinkResponse: type: object description: Response containing a login link for a managed team user properties: login_url: type: string format: uri description: The signed URL that the user can use to log in valid_until: type: string description: Timestamp indicating when the login link expires (Y-m-d H:i:s format) DecoupleTeamResponse: type: object description: Response when decoupling a team from reseller properties: message: { type: string } CreateCronCheckRequest: type: object description: Request to create a cron check required: [name, type] properties: name: type: string description: Name of the cron job type: type: string enum: [simple, cron] description: Type of cron check (simple or cron expression) frequency_in_minutes: type: integer description: Frequency in minutes (required for simple type) grace_time_in_minutes: type: integer description: Grace time in minutes before alerting cron_expression: type: string description: Cron expression (required for cron type) server_timezone: type: string description: Server timezone (required for cron type) description: type: string description: Description of the cron job SyncCronChecksRequest: type: object description: Request to synchronize cron checks required: [cron_checks] properties: cron_checks: type: array description: List of cron checks to sync. Any existing cron checks not in this list will be deleted. items: $ref: "#/components/schemas/CreateCronCheckRequest" DnsHistoryItem: type: object description: A DNS history record properties: id: { type: integer } authoritative_nameservers: type: array items: { type: string } dns_records: type: array items: type: object properties: host: { type: string } ttl: { type: integer } class: { type: string } type: { type: string } ip: { type: string } raw_dns_records: type: object additionalProperties: type: array items: { type: string } issues: type: array items: { type: object } diff_summary: { type: string } created_at: { type: string } DnsHistoryResponse: type: object description: Response containing DNS history properties: data: type: array items: $ref: "#/components/schemas/DnsHistoryItem" DomainInfo: type: object description: Domain registration information from RDAP properties: expires_at: type: ["string", "null"] registered_at: type: ["string", "null"] last_changed_at: type: ["string", "null"] last_updated_in_rdap_db_at: type: ["string", "null"] domain_statuses: type: object additionalProperties: { type: boolean } rdap_domain_response: type: object additionalProperties: true created_at: { type: string } ApplicationHealthCheckHistoryItem: type: object description: A historical application health check result properties: id: { type: integer } status: type: string enum: [ok, warning, failed, crashed, skipped] message: { type: string } short_summary: { type: string } meta: type: object additionalProperties: true detected_at: { type: string } updated_at: { type: string } ApplicationHealthCheckHistoryResponse: type: object description: Response containing application health check history properties: data: type: array items: $ref: "#/components/schemas/ApplicationHealthCheckHistoryItem" LighthouseReport: type: object description: A Lighthouse performance report properties: id: { type: integer } performance_score: { type: number } accessibility_score: { type: number } best_practices_score: { type: number } seo_score: { type: number } progressive_web_app_score: { type: ["number", "null"] } first_contentful_paint_in_ms: { type: number } speed_index_in_ms: { type: number } largest_contentful_paint_in_ms: { type: number } time_to_interactive_in_ms: { type: number } total_blocking_time_in_ms: { type: number } cumulative_layout_shift: { type: number } performed_on_checker_server: { type: string } json_report: type: object additionalProperties: true issues: type: array items: type: object properties: category: { type: string } actualScore: { type: number } notificationThreshold: { type: number } created_at: { type: string } PaginatedLighthouseReports: type: object description: Paginated list of Lighthouse reports properties: data: type: array items: $ref: "#/components/schemas/LighthouseReport" links: $ref: "#/components/schemas/Links" meta: type: object properties: current_page: { type: integer } from: { type: integer } last_page: { type: integer } per_page: { type: integer } to: { type: integer } total: { type: integer } AiResponse: type: object description: An AI monitoring response properties: id: { type: integer } result: type: string enum: [ok, failed, error] finish_reason: type: string enum: [stop, length, contentFilter, toolCalls, error, other, unknown] prompt: { type: string } text: { type: string } notification_title: type: ["string", "null"] notification_body: type: ["string", "null"] used_tools: type: array items: type: object properties: name: { type: string } arguments: { type: object, additionalProperties: true } displayName: { type: string } displayArguments: type: array items: { type: string } used_prompt_tokens: { type: integer } used_completion_tokens: { type: integer } raw_response: type: ["string", "null"] started_at: { type: string } ended_at: { type: string } created_at: { type: string } PaginatedAiResponses: type: object description: Paginated list of AI responses properties: data: type: array items: $ref: "#/components/schemas/AiResponse" links: $ref: "#/components/schemas/Links" meta: type: object properties: current_page: { type: integer } from: { type: integer } last_page: { type: integer } per_page: { type: integer } to: { type: integer } total: { type: integer } TagsResponse: type: object description: Response containing a list of tags properties: data: type: array items: $ref: "#/components/schemas/Tag" CreateTagRequest: type: object description: Request to create a tag required: [team_id, name] properties: team_id: type: integer description: The ID of your team name: type: string description: The name of the tag monitors: type: array description: Array of monitor IDs to associate with the tag items: { type: integer } sites: type: array description: Array of site/monitor IDs to associate with the tag (deprecated, use monitors) items: { type: integer } deprecated: true PaginatedTagGroups: type: object description: Paginated list of tag groups properties: data: type: array items: $ref: "#/components/schemas/TagGroup" links: $ref: "#/components/schemas/Links" meta: type: object properties: current_page: { type: integer } from: { type: integer } last_page: { type: integer } per_page: { type: integer } to: { type: integer } total: { type: integer } CreateTagGroupRequest: type: object description: Request to create a tag group required: [team_id, label] properties: team_id: type: integer description: The ID of your team label: type: string description: The label of the tag group tags: type: array description: Array of tag names to associate with the group. Non-existing tags will be created. items: { type: string } UpdateTagGroupRequest: type: object description: Request to update a tag group properties: label: type: string description: The label of the tag group tags: type: array description: Array of tag names. An empty array removes all tags. Omit to keep tags unchanged. items: { type: string } TeamNotificationDestinationsResponse: type: object description: Response containing a list of team notification destinations properties: data: type: array items: $ref: "#/components/schemas/TeamNotificationDestination" MonitorNotificationDestinationsResponse: type: object description: Response containing a list of monitor notification destinations properties: data: type: array items: $ref: "#/components/schemas/MonitorNotificationDestination" TagNotificationDestinationsResponse: type: object description: Response containing a list of tag notification destinations properties: data: type: array items: $ref: "#/components/schemas/TagNotificationDestination" TagGroupNotificationDestinationsResponse: type: object description: Response containing a list of tag group notification destinations properties: data: type: array items: $ref: "#/components/schemas/TagGroupNotificationDestination" CreateNotificationDestinationRequest: type: object description: Request to create a notification destination required: [channel, destination] properties: channel: $ref: "#/components/schemas/NotificationChannel" label: type: string description: Optional label for the notification destination destination: type: object description: Channel-specific destination configuration additionalProperties: true notification_types: type: array description: List of notification types to receive. Omit for all types. items: { type: string } test: type: boolean description: Whether to send a test notification after creation default: false UpdateNotificationDestinationRequest: type: object description: Request to update a notification destination properties: channel: $ref: "#/components/schemas/NotificationChannel" label: type: string description: Optional label for the notification destination destination: type: object description: Channel-specific destination configuration additionalProperties: true notification_types: type: array description: List of notification types to receive items: { type: string } test: type: boolean description: Whether to send a test notification after update default: false PortScanResult: type: object description: A port scan history result properties: id: { type: integer } scanned_host: { type: string } expected_open_results: type: array items: $ref: "#/components/schemas/PortScanResultItem" expected_closed_results: type: array items: $ref: "#/components/schemas/PortScanResultItem" issues: type: array items: $ref: "#/components/schemas/PortScanIssue" scan_time_ms: { type: integer } created_at: { type: string } PortScanResultItem: type: object description: A single port result within a port scan properties: port: { type: integer } status: { type: string } response_time_ms: type: ["integer", "null"] error_message: type: ["string", "null"] PortScanIssue: type: object description: An issue found during port scanning properties: name: { type: string } ports: type: array items: { type: integer } DnsBlocklistResult: type: object description: A DNS blocklist check result properties: id: { type: integer } checked_domain: { type: string } resolved_ips: type: array items: { type: string } blocklist_results: type: array items: $ref: "#/components/schemas/BlocklistResultItem" issues: type: ["array", "null"] items: { type: object } created_at: { type: string } BlocklistResultItem: type: object description: A single blocklist check result properties: provider: { type: string } listed: { type: boolean } query_target: type: ["string", "null"] return_code: type: ["string", "null"] reason: type: ["string", "null"] timed_out: { type: boolean } PublicMetrics: type: object description: Public API metrics counters properties: run_count: { type: integer } notification_count: { type: integer } RecurringMaintenancePeriod: type: object description: A recurring maintenance period for a monitor properties: id: { type: integer } monitor_id: { type: integer } name: type: ["string", "null"] recurrence_type: type: string enum: [daily, weekly, monthly] days_of_week: type: ["array", "null"] items: { type: integer, minimum: 0, maximum: 6 } day_of_month: type: ["integer", "null"] minimum: 1 maximum: 31 start_time: { type: string, description: "Time of day in HH:MM format" } end_time: type: string description: "Time of day in HH:MM format. Must differ from start_time." human_readable_schedule: { type: string } last_generated_until: type: ["string", "null"] description: "Date (Y-m-d) up to which periods have been generated" created_at: { type: string } updated_at: { type: string } CreateRecurringMaintenancePeriodRequest: type: object description: Request to create a recurring maintenance period required: [monitor_id, name, recurrence_type, start_time, end_time] properties: monitor_id: { type: integer } name: { type: string } recurrence_type: type: string enum: [daily, weekly, monthly] days_of_week: type: array description: Required when recurrence_type is weekly. Values 0..6. items: { type: integer, minimum: 0, maximum: 6 } day_of_month: type: integer description: Required when recurrence_type is monthly. Values 1..31. minimum: 1 maximum: 31 generate_now: type: boolean default: true start_time: { type: string, description: "Time of day in H:i format" } end_time: type: string description: "Time of day in H:i format. Must differ from start_time." UpdateRecurringMaintenancePeriodRequest: type: object description: Request to update a recurring maintenance period properties: name: { type: string } recurrence_type: type: string enum: [daily, weekly, monthly] days_of_week: type: array items: { type: integer, minimum: 0, maximum: 6 } day_of_month: type: integer minimum: 1 maximum: 31 start_time: { type: string, description: "Time of day in H:i format" } end_time: type: string description: "Time of day in H:i format. Must differ from start_time." regenerate_future_periods: type: boolean default: true StatusPageUpdateTemplate: type: object description: A reusable template for status page updates properties: id: { type: integer } team_id: { type: integer } name: type: ["string", "null"] title: type: ["string", "null"] text: type: ["string", "null"] severity: type: ["string", "null"] enum: [info, warning, high, resolved, scheduled, null] created_at: { type: string } updated_at: { type: string } CreateStatusPageUpdateTemplateRequest: type: object description: Request to create a status page update template required: [team_id] properties: team_id: { type: integer } name: { type: string } title: { type: string } text: { type: string } severity: { type: string, enum: [info, warning, high, resolved, scheduled] } UpdateStatusPageUpdateTemplateRequest: type: object description: Request to update a status page update template properties: name: { type: string } title: { type: string } text: { type: string } severity: { type: string, enum: [info, warning, high, resolved, scheduled] } UpdateCronCheckRequest: type: object description: Request to update a cron check properties: name: { type: string } type: { type: string, enum: [simple, cron] } frequency_in_minutes: { type: integer } grace_time_in_minutes: { type: integer } cron_expression: { type: string } server_timezone: { type: string } description: { type: string } UpdateMaintenancePeriodRequest: type: object description: Request to update a scheduled maintenance period required: [starts_at, ends_at] properties: starts_at: { type: string, description: "Start date and time in Y-m-d H:i format" } ends_at: { type: string, description: "End date and time in Y-m-d H:i format" } name: type: ["string", "null"] UpdateStatusPageUpdateRequest: type: object description: Request to update a status page update required: [title, severity] properties: title: { type: string } text: { type: string } severity: { type: string, enum: [info, warning, high, resolved, scheduled] } time: { type: string, description: "UTC Y-m-d H:i" } pinned: { type: boolean } NoContent: type: "null" description: No content returned properties: {} Error: type: object description: Error response properties: message: { type: string } errors: type: object additionalProperties: type: array items: { type: string } ErrorMessage: type: object description: Error response properties: error: { type: string } responses: NoContent: description: No Content content: application/json: schema: $ref: "#/components/schemas/NoContent" Unauthorized: description: Unauthenticated content: application/json: schema: $ref: "#/components/schemas/ErrorMessage" examples: default: value: error: Unauthenticated. Forbidden: description: Forbidden content: application/json: schema: $ref: "#/components/schemas/Error" examples: default: value: message: This action is unauthorized. NotFound: description: > Not Found. Returned when the resource does not exist, and also when it belongs to a team you are not a member of or your token is not allowed to access it, so that the response does not reveal whether the resource exists. content: application/json: schema: $ref: "#/components/schemas/Error" examples: default: value: message: Not found. Validation: description: Validation error content: application/json: schema: $ref: "#/components/schemas/Error" examples: missing_url: value: message: The given data was invalid. errors: url: - The url field is required. TooManyRequests: description: Too many requests content: application/json: schema: $ref: "#/components/schemas/ErrorMessage" examples: default: value: error: Too Many Attempts.