Working with the API
Errors
Plane uses standard HTTP response codes to indicate the success or failure of an API request.
Codes in the
Most errors will include an error code that can be used to handle the issue programmatically, and explain the problem reported.
2xx range indicate success. Codes in the 4xx range indicate an error that failed given the information provided.
Codes in the 5xx range indicate an error with Plane’s servers.
| HTTP Status Codes | |
|---|---|
200 OK | Everything worked as expected. The request was unacceptable, often due to missing a required parameter. |
400 Bad Request | The request was unacceptable, often due to missing a required parameter. |
401 Unauthorized | No valid API key provided. |
403 Forbidden | The API key doesn’t have permissions to perform the request. |
404 Not Found | The requested resource doesn’t exist. |
Attributes
A short string indicating the error code reported.
A human-readable message providing more details about the error.
An object with key-value pairs that may provide more details about the error.
For example, a parameter validation error will have the list of parameters
that are invalid with reasons. In some cases, details may be an empty object.
Error codes
Below is a list of error codes that Plane may return in thecode field, along with information on how to resolve them.
| Error code | Description |
|---|---|
address_invalid | Invalid address. There are many potential messages you may receive for an invalid address error. |