Skip to main content
Plane uses standard 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 that failed given the information provided. Codes in the 5xx range indicate an error with Plane’s servers.
HTTP Status Codes
200 OKEverything worked as expected. The request was
unacceptable, often due to missing a required parameter.
400 Bad RequestThe request was unacceptable, often due to
missing a required parameter.
401 UnauthorizedNo valid API key provided.
403 ForbiddenThe API key doesn’t have permissions to perform the request.
404 Not FoundThe requested resource doesn’t exist.
Most errors will include an error code that can be used to handle the issue programmatically, and explain the problem reported.

​
Attributes

​
code
string
A short string indicating the error code reported.
​
message
string
A human-readable message providing more details about the error.
​
details
hash
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 the code field, along with information on how to resolve them.
Error codeDescription
address_invalidInvalid address. There are many potential messages you may receive for an invalid address error.