API Reference

The ATStatus REST API allows you to programmatically manage your status pages, components, incidents, and more.

Base URL: All API requests should be made to https://your-domain.com/api/v1

Authentication

Include your API key in the Authorization header:

Authorization: Bearer your-api-key-here

Generate API keys in Admin Panel → API Keys

API Key Scopes

read

Read-only access to all resources

write

Create and update access

admin

Full administrative access

API Sections

Authentication

API key authentication setup

Status Pages

Manage status pages via API

Components

Create and update components

Incidents

Incident management endpoints

Maintenance

Schedule maintenance via API

Public API

Read-only public endpoints

Quick Example

curl -X POST https://status.example.com/api/v1/incidents \
  -H "Authorization: Bearer your-api-key" \
  -H "Content-Type: application/json" \
  -d '{
    "title": "Database connectivity issues",
    "status": "investigating",
    "impact": "major"
  }'

Rate Limiting

API requests are rate limited to prevent abuse:

100

requests/minute per key

1,000

requests/hour per key

SDK Available! We provide official SDKs for JavaScript/TypeScript and Python. View API Reference →