Errors and Status Codes

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.

200 – Okay

Status: Everything worked as expected.

201 – Success

Status: The request was successfully submitted.

400 – Bad Request

Status: This can often be due to missing a required parameter.

Troubleshooting: Check for missing or incorrect parameters and try again.

401 – No Authentication

Status: No valid API token was provided.

Troubleshooting: Ensure you are using a valid API token and try again. See API Token Management.

402 – Request Failed

Status: The parameters were valid but the request failed.

403 – Unauthorized

Status: You do not have permission to access this resource.

404 – Not Found

Status: The specified resource could not be found.

405 – Method Not Allowed

Status: An unsupported request type was attempted.

409 – Conflict

Status: There’s a discrepancy between the request and the target resource.

Troubleshooting: Check the resource, resolve any conflicting information, and then try again. Refer to Cloudflare Troubleshooting for more information.

422 – Validation error.

Status: There was a validation error.

429 – Rate Limit Reached

Status: Too many requests in quick succession. 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.

Troubleshooting:

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.

Wait 1 minute, and then try again. We recommend employing an exponential backoff strategy when retrying your calls.

• In general, rates are limited to 5000 requests within 5 minutes.
• In times of heavy processing, rates might be limited to 100 requests within 5 minutes.

500 – Server Error

Status: Something went wrong on the Bitsight end.

Troubleshooting: Retry the request. If the problem persists, it may indicate an issue with the Bitsight platform. Contact Bitsight Support.

502 – Server Error

Status: Something went wrong on the Bitsight end.

Troubleshooting: Retry the request. If the problem persists, it may indicate an issue with the Bitsight platform. Contact Bitsight Support.

503 – Server Error

Status: Something went wrong on the Bitsight end.

Troubleshooting: Retry the request. If the problem persists, it may indicate an issue with the Bitsight platform. Contact Bitsight Support.

504 – Server Error

Status: An error occurred in Cloudflare.

Troubleshooting: Refer to Cloudflare Troubleshooting for more information.

524 – Time Out

Status: The connection to the web server was successful, but the connection timed out.

Troubleshooting: Refer to Cloudflare Troubleshooting for more information.