Introduction
This documentation describes the API for the Incipulse Status Page.
Code of Conduct
Please don't abuse the API, and please report all feature requests and issues to [email protected]
Rate Limiting
Each API token is limited to 1 request / second as measured on a 60-second rolling window. To get this limit increased, please contact us at [email protected]
Error codes 420 or 429 indicate that you have exceeded the rate limit and the request has been rejected.
Basics
HTTPS
It's required. All communication with the API must be over HTTPS to ensure data security.
URL Prefix
In order to maintain version integrity into the future, the API is versioned. All calls currently begin with the following prefix:
https://api.incipulse.com/v1/
RESTful Interface
Wherever possible, the API seeks to implement repeatable patterns with logical, representative URLs and descriptive HTTP verbs.
HTTP Verbs
- GET: Retrieve information about a collection or a specific element.
- POST: Create a new element in a collection.
- PATCH/PUT: Update or replace an element.
- DELETE: Destroy a single element.
Sending Data
Information can be sent in the body as JSON (recommended) or Form URL-encoded. Ensure the Content-Type header matches your body structure.
Responses & Error Codes
| Code | Meaning |
|---|---|
| 200 | Success |
| 201 | Created |
| 400 | Bad Request (Validation failure) |
| 401 | Unauthorized |
| 403 | Forbidden |
| 404 | Not Found |
| 409 | Conflict |
| 420/429 | Rate Limit Exceeded |
| 500 | Internal Server Error |