REST API Authentication
Last updated 13 days ago
Using your API key
Include your API key in the Authorization header:
Authorization: Bearer sf_live_your_key_hereWrite Bearer with a capital B, followed by one space.
Base URL
https://statusforge.net/api
Available endpoints
With an API key, you can use:
- StatusForge: Services (
/api/services) and incidents (/api/incidents): list, create, update and delete. Subscribers (/api/subscribers): list only. - ChangeForge: Changelog posts (
/api/changelog): list, create, read, update and delete. - HelpForge: Categories (
/api/help/categories) and articles (/api/help/articles): list, create, read, update and delete. Help center settings (/api/help/settings): read and update. - Account: Settings (
/api/settings): read only.
To change account settings, manage billing, team members or API keys, or remove subscribers, log in to the dashboard. With an API key, those endpoints return 401.
An OpenAPI spec for the services, incidents, changelog and subscribers endpoints is at https://statusforge.net/openapi.json.
Rate limits
- 60 requests per minute per IP address, for all requests
- 100 requests per minute per API key
See API Rate Limits for details.
Error responses
Most errors return JSON with an error field, for example {"error": "Unauthorized"}. Some responses also include a message or details field. Common status codes:
- 401: Missing or invalid API key, or the endpoint needs a dashboard login
- 403: The product is turned off, or you don't have permission
- 429: Rate limit exceeded