Status Codes
The AuthRocket APIs use standard HTTP response codes to indicate whether an API request succeeded or failed.
Status: 200
Request succeeded; payload is included.
Status: 201
Request to create a resource succeeded; payload is included.
Status: 202
Request accepted, but not completed and may or may not succeed.
Status may need to be verified at a later time.
Status: 204
Request succeeded; no payload.
Status: 302, 303, 307
Redirect to another location. Clients should be prepared to follow a limited number of redirects.
Status: 400
Bad request; generally a missing parameter, encoding error, or malformed request.
Status: 402
AuthRocket subscription is not active or otherwise needs attention. Login to the management portal.
Status: 403
API authentication failed. This can be because authentication credentials were missing, incomplete, incorrect, or lack sufficient permission to perform the current request.
Status: 404
Resource not found or not accessible to the current user. The latter case means that you may receive a 404 instead of a 403 in certain instances.
Status: 405
Method not allowed. Resource URI is recognized, but the HTTP verb sent is not valid for it. For example, sending a POST when only a PUT is allowed for that URI. Can also be an invalid HTTP verb, such as POSST.
Status: 406
Request not acceptable. Returned if requesting an unavailable document content type. Ensure that a proper Accept: header is being sent.
Status: 409
There was a conflict when attempting to update the resource. Most often this is a failed attempt to delete a resource that is in a state that prevents it from being deleted at this time. Should return a validation error like 422.
Status: 414
Returned when the request URL is too long.
Status: 415
Returned if submitting data using an unrecognized content-type (currently anything other than JSON or standard URL encoded form data).
Status: 417
Most commonly, returned when using one of .NET’s HTTP clients that automatically enable the expect header. In that case, set Expect100Continue = false.
Status: 422
Validation error. May be returned for POST, PUT, and DELETE operations.
Example
{
"errors": [
"Name is required."
],
"message": "Validation failed"
}
if (resp.hasErrors()) {
console.log(resp.errors)
}
// => ["Name is required."]if ($res->hasErrors()) {
var_dump($res->errors);
}
// =>
array(1) {
[0]=> string(17) "Name is required."
}# org => #<AuthRocket::Org:0x0123456789ab ...>
org.errors? # => true
org.valid? # => false
org.errors
# => ["Name is required."]Status: 429
Rate limiting thresholds have been exceeded. HTTP headers containing the current rate limiting status are included with 429 and 2xx responses. Rate limits vary based on API endpoint and your current service plan.
Ratelimit-Limit: 1234
Ratelimit-Remaining: 0
Ratelimit-Reset: Mon, 20 Jan 2020 20:00:00 GMT
Retry-After: 9
Retry-After is in seconds.
Upon receiving a 429, please refrain from retrying until at least Retry-After + 1 seconds have passed (+1 to account for rounding). Alternatively, wait until the time indicated in Ratelimit-Reset.
Status: 500, 502
An error happened on AuthRocket’s side. Wait a few minutes and try again. Also ensure your request is properly formed.
Status: 503, 504
Service unavailable. This may be in response to heavy load, to exceeding rate-limiting thresholds, or server errors. Wait a few minutes and try again. Exponential backoff is recommended.
Additional Notes
Clients must read the actual HTTP status header (and other headers as appropriate) prior to attempting to interpret the JSON body payload. Payloads for errors (4xx, 5xx) are intended to be informative, but may change.