API & Integrations
REST API Reference
Complete reference for all PingBase API endpoints. All authenticated endpoints require a Bearer token in the Authorization header.
Base URL
Response Format
All API responses follow a consistent format:
Success Response
{
"success": true,
"data": { ... },
"meta": { "total": 10, "page": 1 }
}Error Response
{
"success": false,
"error": {
"code": "VALIDATION_ERROR",
"message": "Invalid request body",
"details": [...]
}
}Endpoints
/api/public/v1/statusList all public status pages.
/api/v1/status/:slugGet a specific status page with components, active incidents, and maintenance.
/api/v1/status/:slug/subscribeSubscribe an email address to status page notifications.
/api/v1/widget/:slugGet status badge (SVG) or JSON summary for embedding.
/api/v1/componentsList all components for the authenticated organization.
/api/v1/componentsCreate a new component.
/api/v1/components/:idUpdate a component (name, status, description, etc.).
/api/v1/incidentsList all incidents for the authenticated organization.
/api/v1/incidentsCreate a new incident with affected components.
/api/v1/incidents/:idUpdate an incident (status, impact, post an update message).
/api/v1/monitorsList all monitors for the authenticated organization.
/api/v1/monitorsCreate a new monitor.
/api/v1/analyticsGet uptime metrics, response times, and incident statistics.
HTTP Status Codes
| Code | Meaning |
|---|---|
| 200 | Success |
| 201 | Created |
| 400 | Bad Request — validation error |
| 401 | Unauthorized — missing or invalid API key |
| 403 | Forbidden — insufficient scopes |
| 404 | Not Found |
| 429 | Rate limit exceeded |
| 500 | Internal server error |