This developer site is currently in an open beta. Feel free to give us feedback in the Discussion section of this site.
Welcome to StatusCast's API reference guide! You can use this API to interact with our endpoints to automate, extend and integrate StatusCast with other services. If you have any questions or experience any issues utilizing this API please reach out to StatusCast's support team at [email protected].
The Basics
This API is organized around REST and all requests should be made over SSL. Your status page has a unique StatusCast URL, throughout this guide where examples state 'sample.statuscast.com' it should be noted that sample needs to be replaced with your unique domain name.
API Responses
The StatusCast API returns standard HTTP success or error status codes. For errors, we will include extra information about what went wrong encoded in the response as JSON. In some cases successes will return additional information, such as an Incident ID after it's creation, please refer to individual endpoints for any specific response information. Typical HTTP status codes we may return include:
| Code | Title | Description |
|---|---|---|
| 200 | OK | The request was successful. |
| 400 | Bad request | A bad request was submitted. |
| 401 | Unauthorized | An unauthenticated request for a resources that requires an authorization token |
| 403 | Forbidden | Authorization token lacks the proper priveleges to access the resources |
| 404 | Not found | The requested resource does not exist. |
| 405 | Not Allowed | The request for the specific resource is not allowed |
| 500 | Error | An occurred with the request |