Docs

Type a word or a question. Esc closes the search.

Sign in Start free

Get a scheduled job

Returns status, timing, signing and billing-pause details when present.

GET https://app.upfour.io/v1/heartbeats/{heartbeatID}
GET https://app.upfour.io/v1/heartbeats/{heartbeatID}
Authorization
AuthorizationA pls_ key. It stays in this browser tab. Needs heartbeat.read.
Path

Sent directly from your browser to https://app.upfour.io/v1. Mutating calls get an automatic Idempotency-Key when the field is empty.

Request
Responsenot sent yet
Fill in a key and press Send request (⌘↵).
The answer appears here.
scope heartbeat.read stable returns 200

Parameters

FieldTypeDescription
heartbeatID required uuid path parameter

Returns

A successful request returns 200 with application/json.

Response fields 1 top-level fields
FieldTypeDescription
data Heartbeat
Heartbeat · 26 fields
FieldTypeDescription
created_at string (date-time)
expected_interval_seconds integer
first_ping_at string (date-time) · nullable
grace_period_seconds integer
has_signing_secret boolean
id uuid
last_outcome_cause string
last_ping_at string (date-time) · nullable
name string
organization_id uuid
slug string
status string one ofupdownpausedpending
updated_at string (date-time)
billing_paused_at string (date-time)
billing_pauses BillingPause[]
Each item · 2 fields
FieldTypeDescription
paused_at string (date-time) · nullable
resumed_at string (date-time) · nullable
billing_resumed_at string (date-time)
client_id uuid
flapping HeartbeatFlap
HeartbeatFlap · 3 fields
FieldTypeDescription
changes_last_hour integer
next_notice_at string (date-time)
since string (date-time)
heartbeat_group_id uuid
ping_url string
signing_secret string Only in the answer to the create or update that set it; has_signing_secret says whether one is set.

Errors

Only the errors this operation can return. Every error uses the same envelope.

Status Code Meaning
400 bad_request The request is malformed or fails validation.
404 not_found The requested resource does not exist or is outside the caller's scope.

Every call can also return unauthorized (401), rate_limit_exceeded (429) or internal_error (500 / 502). See Responses and errors.