API reference · Pages & reporting Reports Availability and SLA reporting: summaries, trends, exports, schedules, share links.
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 /reports/agency-ribbonGET /reports/downtime-ledgerGET /reports/exportGET /reports/incidentsGET /reports/monitor-ribbonGET /reports/monitorsGET /reports/response-timeGET /reports/runsGET /reports/schedulesPOST /reports/schedulesGET /reports/schedules/{scheduleID}PUT /reports/schedules/{scheduleID}DELETE /reports/schedules/{scheduleID}POST /reports/schedules/{scheduleID}/run-nowGET /reports/share-linksDELETE /reports/share-links/{linkID}GET /reports/slaGET /reports/summaryGET /reports/trendsGET /reports/verify/{hash}POST /reports/{runID}/share GET /reports/agency-ribbon scope report.read stable returns 200
curl -s https://app.upfour.io/v1/reports/agency-ribbon \
-H "Authorization: Bearer $UP4_API_KEY" Try it GET /reports/downtime-ledger scope report.read stable returns 200
curl -s https://app.upfour.io/v1/reports/downtime-ledger \
-H "Authorization: Bearer $UP4_API_KEY" Try it GET /reports/export scope report.read stable returns 200
curl -s https://app.upfour.io/v1/reports/export \
-H "Authorization: Bearer $UP4_API_KEY" Try it GET /reports/incidents scope report.read stable returns 200
curl -s https://app.upfour.io/v1/reports/incidents \
-H "Authorization: Bearer $UP4_API_KEY" Try it GET /reports/monitor-ribbon scope report.read stable returns 200
curl -s https://app.upfour.io/v1/reports/monitor-ribbon \
-H "Authorization: Bearer $UP4_API_KEY" Try it GET /reports/monitors scope report.read stable returns 200
curl -s https://app.upfour.io/v1/reports/monitors \
-H "Authorization: Bearer $UP4_API_KEY" Try it GET /reports/response-time scope report.read stable returns 200
curl -s https://app.upfour.io/v1/reports/response-time \
-H "Authorization: Bearer $UP4_API_KEY" Try it GET /reports/runs scope report.read stable returns 200
curl -s https://app.upfour.io/v1/reports/runs \
-H "Authorization: Bearer $UP4_API_KEY" Try it GET /reports/schedules scope report.read stable returns 200
curl -s https://app.upfour.io/v1/reports/schedules \
-H "Authorization: Bearer $UP4_API_KEY" Try it POST /reports/schedules scope report.read stable returns 201
curl -s -X POST https://app.upfour.io/v1/reports/schedules \
-H "Authorization: Bearer $UP4_API_KEY" \
-H "Content-Type: application/json" \
-d '{}' Try it GET /reports/schedules/{scheduleID} scope report.read stable returns 200
Parameter In Type Notes scheduleIDrequired path uuid
curl -s https://app.upfour.io/v1/reports/schedules/<scheduleID> \
-H "Authorization: Bearer $UP4_API_KEY" Try it PUT /reports/schedules/{scheduleID} scope report.read stable returns 200
Parameter In Type Notes scheduleIDrequired path uuid
curl -s -X PUT https://app.upfour.io/v1/reports/schedules/<scheduleID> \
-H "Authorization: Bearer $UP4_API_KEY" \
-H "Content-Type: application/json" \
-d '{}' Try it DELETE /reports/schedules/{scheduleID} scope report.read stable returns 204
Parameter In Type Notes scheduleIDrequired path uuid
curl -s -X DELETE https://app.upfour.io/v1/reports/schedules/<scheduleID> \
-H "Authorization: Bearer $UP4_API_KEY" Try it POST /reports/schedules/{scheduleID}/run-now scope report.read stable returns 201
Parameter In Type Notes scheduleIDrequired path uuid
curl -s -X POST https://app.upfour.io/v1/reports/schedules/<scheduleID>/run-now \
-H "Authorization: Bearer $UP4_API_KEY" \
-H "Content-Type: application/json" \
-d '{}' Try it GET /reports/share-links scope report.read stable returns 200
curl -s https://app.upfour.io/v1/reports/share-links \
-H "Authorization: Bearer $UP4_API_KEY" Try it DELETE /reports/share-links/{linkID} scope report.read stable returns 204
Parameter In Type Notes linkIDrequired path uuid
curl -s -X DELETE https://app.upfour.io/v1/reports/share-links/<linkID> \
-H "Authorization: Bearer $UP4_API_KEY" Try it GET /reports/sla scope report.read stable returns 200
curl -s https://app.upfour.io/v1/reports/sla \
-H "Authorization: Bearer $UP4_API_KEY" Try it GET /reports/summary scope report.read stable returns 200
curl -s https://app.upfour.io/v1/reports/summary \
-H "Authorization: Bearer $UP4_API_KEY" Try it GET /reports/trends scope report.read stable returns 200
curl -s https://app.upfour.io/v1/reports/trends \
-H "Authorization: Bearer $UP4_API_KEY" Try it GET /reports/verify/{hash} scope report.read stable returns 200
Parameter In Type Notes hashrequired path uuid
curl -s https://app.upfour.io/v1/reports/verify/<hash> \
-H "Authorization: Bearer $UP4_API_KEY" Try it POST /reports/{runID}/share scope report.read stable returns 201
Parameter In Type Notes runIDrequired path uuid
curl -s -X POST https://app.upfour.io/v1/reports/<runID>/share \
-H "Authorization: Bearer $UP4_API_KEY" \
-H "Content-Type: application/json" \
-d '{}' Try it