Response codes (success and error)
The BlazeMeter API uses conventional HTTP response codes to indicate the success or failure of an API request. Generally, codes in the 2xx range indicate success, codes in the 4xx range indicate client errors (an error that failed to provide the required information such as a missing required parameter), and codes in the 5xx range indicate server errors. The sample response indicates a failure of the API request due to not providing a valid API key.
Not all errors map cleanly to HTTP response codes. When a request is valid but does not complete successfully, a 402 response code is returned.
The BlazeMeter API uses the following response codes:
| Code | Name | Description |
|---|---|---|
| 200 | OK | Everything worked as expected |
| 201 | Created | Status when you create a new entity and everything worked as expected |
| 204 | No content | The server successfully processed the request and does not return any content |
| 400 | Bad Request | The request was unacceptable. Missing a required parameter, bad request syntax, or too large a size, are some of the common causes of this code. |
| 401 | Unauthorized | No valid API key provided |
| 402 | Request Failed | The parameters were valid, but the request failed |
| 403 | Forbidden | The API Key does not have permission to perform this action |
| 404 | Not Found | The requested resource does not exist |
| 409 | Conflict | The request conflicts with another request |
| 429 | Too Many Requests | Too many requests sent to the API in too short a period |
| 500, 502, 503, 504 | Server Errors | Something went wrong on BlazeMeter's end |
Response401 Unauthorized
{
"error": {
"code": 401,
"message": "Unauthorized"
},
"api_version": 4,
"result": null
}