Response Codes

Agave API uses conventional HTTP response codes to indicate the success or failure of an API request:

• Codes in the 2xx range indicate success.
• Codes in the 4xx range indicate an error caused by the information provided (e.g. a required parameter was omitted).
• Codes in the 5xx range indicate an error with the Source System or Agave's servers (these are rare).

Agave API standardizes all errors returned from Source Systems, allowing you to only need to account for one form of error management in your application.

Status Code	Response Type	Description
200	OK	Everything worked as expected.
201	Created	A new resource was created.
204	No Content	No content to return (typically when a resource is deleted).
400	Bad Request	The request was unacceptable, often due to missing a required parameter.
401	Unauthorized	No valid API key provided, or the API key doesn't have permissions to perform the request.
403	Forbidden	No valid API key provided, or the API key doesn't have permissions to perform the request.
404	Not Found	The requested resource doesn't exist.
409	Conflict	The request conflicts with another request (perhaps due to using the same idempotent key).
429	Too Many Requests	Too many requests hit the API too quickly, and the Source System rejected the request. See Rate Limits.
500	Internal Server Error	Something went wrong on Agave's end or with the Source System's API.
503	Service Unavailable	Something went wrong on Agave's end or with the Source System's API.