Skip to main content

Downtimes

A downtime is a window during which scheduled Monitors are paused, so planned maintenance does not generate false alerts or count against your conformance and quality results. Downtimes can be applied to an individual schedule, or set at the Organization level so that all schedules respect the same window.

This is a task-oriented guide for working with downtimes. For the underlying REST API, the Org-level Downtime endpoints are documented in the API Reference and are cross-linked throughout this page.

note

Organization-wide downtimes are managed from Organization settings, which is an Enterprise-tier capability. See the pricing page for plan availability.

Downtime scopes​

ScopeWhere you set itWhat it covers
Per-schedule downtimeOn a schedule, via Add Downtime (and New Downtime for all schedules on the Schedules page)A single schedule's runs during the window
Organization-wide downtimeOrganization settings → Downtimes tabAll schedules across the Organization: every schedule respects these windows

The Schedules page notes that "All schedules will respect organization-wide downtimes." Use an Organization-wide downtime for maintenance that affects every project; use a per-schedule downtime for a window that should only pause one schedule.

Add a downtime from the Schedules page​

To pause a single schedule, use the Add Downtime action on that schedule's row. To pause every schedule, use New Downtime for all schedules on the Schedules page. Each downtime has a start and end (with timezone) and can repeat daily or weekly.

For the full step-by-step on per-schedule downtime windows, including the daylight-saving and start-time adjustment behavior, see Managing Project-Level Downtimes.

note

Use the Create Org-level Downtime API reference for the authoritative request schema.

Find a downtime ID​

Every downtime on a schedule has a unique ID. You need it to read, update, or delete the downtime through the API.

  1. Open the Schedules page and find the schedule. Its downtimes are listed after Scheduled Downtimes:.
  2. Select More info to open the Downtimes table. It shows Start Time, End Time, Repeat, and Actions.
  3. In Actions, select Copy ID to copy the ID to your clipboard. The button changes to ID Copied to confirm.
  4. To see the ID in the table, select Select Columns, then turn on Downtime ID.

The ID is the downtime_id in the Get a downtime window, Update a downtime window, and Delete a downtime window endpoints.

Manage Organization-wide downtimes​

Organization-wide downtimes are listed and managed from Organization settings → Downtimes. These windows apply across the Organization, and all schedules respect them.

To manage Organization-wide downtimes:

  1. Open Organization settings for your Organization.
  2. Select the Downtimes tab to view existing Organization downtime windows.
  3. Add, edit, or remove windows as needed.

Managing downtimes with the API​

Org-level downtimes have a full CRUD surface in the REST API. You can list, create, update, and delete downtime configurations across your Organization's projects.

TaskAPI Reference (Try-It)Endpoint guide
List all Org-level downtimesList Org-level DowntimesList Org-level Downtimes
Create a downtime across one or more projectsCreate Org-level DowntimeCreate Org-level Downtime
Update an existing downtimeUpdate Org-level DowntimeUpdate Org-level Downtime
Delete a downtimeDelete Org-level DowntimeDelete Org-level Downtime

These endpoints require a valid Access Token. See the Device Code Authorization Flow for obtaining one.

See also​