ATStatus
ATStatus WikiLoading documentation...

Public API Endpoints

Unauthenticated endpoints for status data

API
No Auth Required

ATStatus provides public API endpoints for reading status page data without authentication. These endpoints are perfect for integrating status information into your own applications, dashboards, or monitoring tools.

Available Endpoints

GET
/api/public/status/{slug}

Status Summary

Get the overall status summary including current status, component states, and active incidents.

Example Response
{
  "status": "operational",
  "statusLabel": "All Systems Operational",
  "components": [
    {
      "id": "comp_1",
      "name": "API",
      "status": "operational"
    },
    {
      "id": "comp_2", 
      "name": "Website",
      "status": "operational"
    }
  ],
  "activeIncidents": [],
  "lastUpdated": "2024-01-15T12:00:00Z"
}
GET
/api/public/status/{slug}/components

Component List

Retrieve all components with their current status, groups, and display order.

Example Response
{
  "components": [
    {
      "id": "comp_1",
      "name": "API",
      "description": "Core API services",
      "status": "operational",
      "group": "Infrastructure",
      "order": 1
    }
  ],
  "groups": [
    {
      "id": "grp_1",
      "name": "Infrastructure",
      "order": 1
    }
  ]
}
GET
/api/public/status/{slug}/incidents

Incidents

Fetch recent incidents with updates and affected components.

Query Parameters: limit, status
Example Response
{
  "incidents": [
    {
      "id": "inc_1",
      "title": "API Performance Degradation",
      "status": "resolved",
      "impact": "minor",
      "createdAt": "2024-01-14T10:00:00Z",
      "resolvedAt": "2024-01-14T12:30:00Z",
      "updates": [
        {
          "status": "resolved",
          "message": "The issue has been resolved.",
          "createdAt": "2024-01-14T12:30:00Z"
        }
      ]
    }
  ]
}
GET
/api/public/status/{slug}/maintenance

Scheduled Maintenance

Get upcoming and ongoing maintenance windows.

Example Response
{
  "maintenance": [
    {
      "id": "maint_1",
      "title": "Database Migration",
      "status": "scheduled",
      "scheduledStart": "2024-01-20T02:00:00Z",
      "scheduledEnd": "2024-01-20T04:00:00Z",
      "affectedComponents": ["comp_1", "comp_2"]
    }
  ]
}
GET
/api/public/status/{slug}/uptime

Uptime Statistics

Retrieve uptime percentages and historical availability data.

Query Parameters: days (default: 90)

Response Format

All public endpoints return JSON with the following conventions:

  • Content-Type: application/json
  • Dates: ISO 8601 format (UTC)
  • Status Codes: 200 for success, 404 if page not found
  • CORS: Enabled for all origins

Rate Limiting

Public endpoints have rate limits to prevent abuse:

EndpointLimitWindow
Status Summary100 requestsper minute
Components60 requestsper minute
Incidents/Maintenance30 requestsper minute

Rate limit headers are included in responses: X-RateLimit-Remaining

Common Use Cases

Status Badges

Create status badges for your README or documentation

Dashboard Integration

Display status in internal monitoring dashboards

Slack/Discord Bots

Build bots that report status changes automatically

Custom Status Pages

Build alternative UIs using the public API data

Caching

Public API responses include cache headers:

Cache-Control: public, max-age=30

For real-time updates, consider using webhooks instead of polling the public API.

Related Documentation