Skip to main content
GET
/
heartbeats
/
{id}
Get a single heartbeat
curl --request GET \
  --url https://upcron.io/api/heartbeats/{id} \
  --header 'Authorization: Bearer <token>'
{
  "data": {
    "id": "9b1deb4d-3b7d-4bad-9bdd-2b0d7b3dcb6d",
    "name": "Daily Backup Job",
    "project_id": "9b1deb4d-3b7d-4bad-9bdd-2b0d7b3dcb6d",
    "grace_period": 3600,
    "next_ping_at": "2024-01-02T12:00:00.000000Z",
    "cron_schedule": "0 2 * * *",
    "created_at": "2024-01-01T12:00:00.000000Z",
    "updated_at": "2024-01-01T12:00:00.000000Z",
    "ping_url": "https://ping.upcron.io/heartbeat/uuid",
    "start_url": "https://ping.upcron.io/heartbeat/uuid/start",
    "fail_url": "https://ping.upcron.io/heartbeat/uuid/fail",
    "project": {
      "id": "9b1deb4d-3b7d-4bad-9bdd-2b0d7b3dcb6d",
      "name": "My Project",
      "description": "Project description"
    }
  }
}

Authorizations

Authorization
string
header
required

Laravel Sanctum Bearer token authentication

Path Parameters

id
string<uuid>
required

Heartbeat ID

Response

Successful response

data
object