- December 8, 2021: 429 – Rate Limit Reached recommendation.
- August 17, 2021: Added “201 – Success.”
- June 21, 2021: Added “403 – Unauthorized.”
We use standard HTTP response codes to indicate success or failure of an API request. Typically, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter was missing), and codes in the 5xx range indicate an error with our servers.
| Code | Status | Description |
|---|---|---|
| 200 | Okay | Everything worked as expected. |
| 201 | Success | The request was successfully submitted. |
| 400 | Bad Request | This can often be due to missing a required parameter. |
| 401 | No Authentication | No valid API token was provided. |
| 402 | Request Failed | Parameters were valid but the request failed. |
| 403 | Unauthorized | You do not have permission to access this resource. |
| 404 | Not Found | The specified resource could not be found. |
| 405 | Method Not Allowed | An unsupported request type was attempted. |
| 409 | Conflict | There’s a discrepancy between the request and the target resource. Check the resource, resolve any conflicting information, and then try again. Refer to Cloudflare Troubleshooting for more information. |
| 429 | Rate Limit Reached |
To maintain performance and ensure a smooth performance of the Bitsight platform, the number of simultaneous requests for certain resources may be reduced. While the majority of the Bitsight API allows for 20 simultaneous requests, some are limited to a lower amount. We recommend no more than 3 concurrent requests, as any more have a potential to reduce performance. Submitting more requests at the same time will not help overall throughput, as the system will take longer to execute each request. In the worst case, it may return an error. Please wait 1 minute, and then try again. We recommend employing an exponential backoff strategy when retrying your calls.
|
| 500 502 503 504 |
Server Errors | Something went wrong on the Bitsight end. |
| 524 | Time Out | The connection to the web server was successful, but the connection timed out. Refer to Cloudflare Troubleshooting for more information. |