API reference · Monitoring Scheduled job groups Folders for scheduled jobs.
Base URL https://app.upfour.io/v1 ·
auth via Authorization: Bearer <key> ·
“Try it” runs from your browser — the key is kept in this tab only. Use a
pls_test_ sandbox key to experiment freely.
GET /heartbeat-groupsPOST /heartbeat-groupsPOST /heartbeat-groups/assignGET /heartbeat-groups/{groupID}PUT /heartbeat-groups/{groupID}DELETE /heartbeat-groups/{groupID} GET /heartbeat-groups scope heartbeat.write stable returns 200
Parameter In Type Notes limit query integer default 50 cursor query string client_id query uuid all_clients query boolean q query string sort query string
curl -s https://app.upfour.io/v1/heartbeat-groups \
-H "Authorization: Bearer $UP4_API_KEY" Try it POST /heartbeat-groups scope heartbeat.write stable returns 201
curl -s -X POST https://app.upfour.io/v1/heartbeat-groups \
-H "Authorization: Bearer $UP4_API_KEY" \
-H "Content-Type: application/json" \
-d '{}' Try it POST /heartbeat-groups/assign scope heartbeat.write stable returns 201
curl -s -X POST https://app.upfour.io/v1/heartbeat-groups/assign \
-H "Authorization: Bearer $UP4_API_KEY" \
-H "Content-Type: application/json" \
-d '{}' Try it GET /heartbeat-groups/{groupID} scope heartbeat.write stable returns 200
Parameter In Type Notes groupIDrequired path uuid
curl -s https://app.upfour.io/v1/heartbeat-groups/<groupID> \
-H "Authorization: Bearer $UP4_API_KEY" Try it PUT /heartbeat-groups/{groupID} scope heartbeat.write stable returns 200
Parameter In Type Notes groupIDrequired path uuid
curl -s -X PUT https://app.upfour.io/v1/heartbeat-groups/<groupID> \
-H "Authorization: Bearer $UP4_API_KEY" \
-H "Content-Type: application/json" \
-d '{}' Try it DELETE /heartbeat-groups/{groupID} scope heartbeat.write stable returns 204
Parameter In Type Notes groupIDrequired path uuid
curl -s -X DELETE https://app.upfour.io/v1/heartbeat-groups/<groupID> \
-H "Authorization: Bearer $UP4_API_KEY" Try it