Check-ins CLI reference

The check-ins command lets you manage check-ins for monitoring cron jobs and scheduled tasks.

All check-ins commands require --project-id.

List check-ins

hb check-ins list --project-id 12345

Required flags:

• --project-id — Project ID

Optional flags:

• -o, --output — Output format: table or json (default: table)

Get check-in details

hb check-ins get --project-id 12345 --id 67890

Required flags:

• --project-id — Project ID
• --id — Check-in ID

Optional flags:

• -o, --output — Output format: text or json (default: text)

Create a check-in

Simple schedule

For jobs that run at regular intervals:

hb check-ins create --project-id 12345 --cli-input-json '{
  "name": "Daily backup",
  "slug": "daily-backup",
  "schedule_type": "simple",
  "report_period": "1440",
  "grace_period": "5"
}'

Cron schedule

For jobs with cron expressions:

hb check-ins create --project-id 12345 --cli-input-json '{
  "name": "Hourly job",
  "slug": "hourly-job",
  "schedule_type": "cron",
  "cron_schedule": "0 * * * *",
  "cron_timezone": "America/New_York",
  "grace_period": "5"
}'

Required flags:

• --project-id — Project ID
• --cli-input-json — JSON payload (inline string or file://path)

JSON fields:

• name — Display name for the check-in
• slug — URL-safe identifier used in the check-in URL
• schedule_type — Either simple or cron
• report_period — For simple schedules: expected interval in minutes
• grace_period — Minutes to wait before alerting
• cron_schedule — For cron schedules: cron expression
• cron_timezone — For cron schedules: timezone (e.g., America/New_York)

Optional flags:

• -o, --output — Output format: text or json (default: text)

Update a check-in

hb check-ins update --project-id 12345 --id 67890 --cli-input-json '{"name": "Updated name"}'

Required flags:

• --project-id — Project ID
• --id — Check-in ID
• --cli-input-json — JSON payload with fields to update

Optional flags:

• -o, --output — Output format: text or json (default: text)

Delete a check-in

hb check-ins delete --project-id 12345 --id 67890

Required flags:

• --project-id — Project ID
• --id — Check-in ID