Uptime

Uptime monitors are called UptimeLink in the API, for example findUptimeLink and createUptimeLink.

Some features and limits mentioned on this page vary by plan. Visit our Pricing page to review the plans.

Fields

UptimeLinkHttp

UptimeLinkLastAccessibility

UptimeLinkNotificationConfig

Queries

findUptimeLink

Paginated, filterable list of your uptime monitors.

query {
  findUptimeLink(query: "status = ACTIVE", limit: 25) {
    pagination {
      count
    }
    items {
      id
      name
      target
      status
      lastRecord {
        accessibilityStatus
        spendTime
      }
    }
  }
}

Parameters

Response: an UptimeLinkList — pagination + items: [UptimeLink!]!. See Pagination & Sorting.

findUptimeLinkRecord

Individual check results, also paginated and filterable.

query {
  findUptimeLinkRecord(query: "uptimeLinkId = \"...\"", limit: 25) {
    items {
      location
      accessibilityStatus
      spendTime
      startTime
    }
  }
}

Parameters

Response: an UptimeLinkRecordList — pagination + items: [UptimeLinkRecord!]!. See Pagination & Sorting.

findUptimeLinkSummary

Aggregated uptime/response-time stats for a monitor over a time range, bucketed into chunks.

query {
  findUptimeLinkSummary(
    id: "..."
    startTime: "2024-01-01T00:00:00Z"
    endTime: "2024-01-31T23:59:59Z"
    chunkSize: 24
  ) {
    responseTime
    uptimePercent
  }
}

Parameters

Response: an UptimeLinkSummary — see Types: UptimeLinkSummaryRecord for the shape of each item in records.

uptimeLocation

Lists the monitoring locations your workspace can use. No arguments.

Only locations enabled for your workspace are returned. Paid plans can see additional locations, and a new location can be opened on request, within 24 hours — contact Support.

Response: an UptimeLocationList — items: [UptimeLocationItem!]!:

Mutations

createUptimeLink

Creates a new uptime monitor.

mutation {
  createUptimeLink(input: {
    target: "https://acme.io"
    checkInterval: 300
    timeout: 10
    notification: { all: true }
  }) {
    id
    name
    status
  }
}

Parameters

UptimeLinkInput fields

UptimeLinkHttpInput fields

Response: the created UptimeLink (see Fields above).

Limits: creation fails once your workspace has reached its plan's uptime monitor limit, or once you have created that many monitors in one day (UTC). Deleted monitors still count toward that day's total.

updateUptimeLink

Updates an existing uptime monitor. Fields you leave out are unchanged, with one exception: http replaces the whole HTTP configuration (method, headers, body, status codes, keywords and authentication), so send the complete http object, not only the setting you want to change.

mutation {
  updateUptimeLink(id: "...", input: { checkInterval: 300 }) {
    id
    checkInterval
  }
}

Parameters

Response: the updated UptimeLink.

deleteUptimeLink / bulkDeleteUptimeLink

mutation {
  deleteUptimeLink(id: "...") {
    affectedRecords
  }
}

mutation {
  bulkDeleteUptimeLink(ids: ["...", "..."]) {
    affectedRecords
  }
}

Parameters

Response: a DeleteResult — { affectedRecords: Int! }.

pauseUptimeLink / resumeUptimeLink

Toggle status between ACTIVE and PASSIVE for one or more monitors, without deleting them.

mutation {
  pauseUptimeLink(ids: ["...", "..."]) {
    affectedRecords
  }
}

Parameters

Response: an UpdateResult — { affectedRecords: Int! }.