Skip to main content
GET
/
heartbeats
List all heartbeats
curl --request GET \
  --url https://upcron.io/api/heartbeats \
  --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"
      }
    }
  ],
  "meta": {
    "current_page": 1,
    "per_page": 20,
    "total": 5,
    "last_page": 1
  }
}

Authorizations

Authorization
string
header
required

Laravel Sanctum Bearer token authentication

Query Parameters

project_id
string<uuid>

Filter heartbeats by specific project ID

page
integer
default:1

Page number for pagination

Required range: x >= 1

Response

Successful response

data
object[]
meta
object