2.2 KiB
2.2 KiB
API Integration User Stories
User stories for the @uptime.link/api programmatic access.
US-API-01: Retrieve Service Status via API
As a DevOps/SRE Engineer, I want to fetch current service status programmatically, So that I can integrate status data into custom dashboards.
Acceptance Criteria
- REST endpoint returns all service statuses
- Can filter by service ID or group
- Response includes uptime metrics
- Supports JSON response format
- API is versioned for backward compatibility
US-API-02: Manage Incidents via API
As a DevOps/SRE Engineer, I want to create and update incidents through the API, So that I can automate incident management workflows.
Acceptance Criteria
- Can create incidents via POST request
- Can post updates to incidents
- Can change incident status
- Can list and filter incidents
- Returns incident ID for reference
US-API-03: Configure Monitoring via API
As a DevOps/SRE Engineer, I want to manage monitored services through the API, So that I can integrate with infrastructure automation tools.
Acceptance Criteria
- Can add new services to monitor
- Can update service configuration
- Can delete services
- Can retrieve current configuration
- Supports bulk operations
US-API-04: Webhook Notifications
As a DevOps/SRE Engineer, I want to receive webhook notifications when status changes, So that I can trigger automated responses to incidents.
Acceptance Criteria
- Can configure webhook URLs
- Webhooks fire on status changes
- Webhooks fire on incident creation/updates
- Payload includes full status details
- Supports webhook signature verification
US-API-05: API Authentication
As a DevOps/SRE Engineer, I want secure authentication for API access, So that only authorized systems can manage my status page.
Acceptance Criteria
- API keys for service-to-service auth
- Keys can be created and revoked
- Can set permissions per key (read-only, full access)
- Rate limiting to prevent abuse
- Audit log of API access