API Reference

HTTP Response Codes

The Aurora API uses conventional HTTP response codes to indicate the success or failure of an API request.

In general:

  • Codes in the 2xx range indicate success.
  • Codes in the 4xx range indicate an error that failed given the information provided (e.g., a required parameter was omitted, authentication failed, etc.).
  • Codes in the 5xx range indicate an error with Aurora's servers (these are rare).

Here is a more detailed summary of some of the codes:

  • 200 Success: The request was successfully processed.

  • 202 Accepted: The request was successfully processed, and the provided information was accepted. This code is commonly used when running an asynchronous job.

  • 204 No Content: The request was successfully processed, and there is no data to return. This code is commonly used when deleting a resource.

  • 400 Bad Request: The request could not be processed due to a formatting error.

  • 401 Unauthorized: The API caller could not be authenticated. This may indicate a missing or incorrect token.

  • 403 Forbidden: The provided authentication token was successfully authenticated but not authorized to perform the intended action.

  • 404 Not Found: The the object/resource referenced does not exist or belongs under another tenant. This can also occur when IDs from other environments are used or when users have deleted certain resources such as a design or project.

  • 405 Method Not Allowed: The request URL or method is invalid. This usually indicates an incorrect URL path or HTTP verb.

  • 409 Conflict: The request was partially processed. The requested resource is currently in use, and could not be accessed. This usually occurs because an operation is in progress. Please wait a moment then try again.

  • 422 Unprocessable Entity: The request could not be processed due to an error in the request payload. This may indicate missing mandatory parameters or invalid inputs. Please check the payload of the API call.

  • 429 Too Many Requests: The request could not be processed because the client exceeded Aurora's API rate limit. For more information, see Rate Limits.

  • 5XX Internal Error: Some internal error occurred on our server. Please contact [email protected] or your dedicated support engineer. If 500 errors persist, please see the Aurora Status Page for information on app status.

Error Message Formats

Error messages are returned in the following format:

{"errors": [{"message": "some error occurred"}, {"message": "some other error occurred"}]}