Errors

HTTP status codes used by the API.

Ploi uses standard HTTP status codes to indicate the success or failure of requests.

Code	Description
`200`	Success - Request completed successfully
`201`	Created - Resource was successfully created
`403`	Forbidden - Your API key is missing the scope this endpoint requires
`422`	Validation Error - Request parameters failed validation
`429`	Too Many Requests - Rate limit exceeded
`500`	Server Error - An internal error occurred
`503`	Maintenance - We are performing maintenance

Missing scope

When your API key does not have the scope an endpoint requires, the response names the missing scope. Scopes cannot be added to an existing API key, so create a new key with that permission.

Missing Scope

{
  "error": "Your API key does not have the right permissions, this request requires the 'network-rules-delete' (Delete network rules) scope. Scopes cannot be added to an existing API key, create a new API key with this permission in your Ploi profile.",
  "missing_scopes": [
    "network-rules-delete"
  ]
}

Subscription Error

If you are not on a paid subscription, you will receive the following response:

Subscription Required

{
  "error": "You are on a free plan, therefore you cannot use this API.",
  "links": [
    "https://ploi.io/profile/subscription",
    "https://ploi.io/pricing"
  ]
}