Database error codes

#Reading an error

Every error is a problem document with a stable code; the errors guide explains the shape. Two kinds matter here:

• A refused request. The API answers with a 4xx or 5xx and nothing changes. For an invalid field the answer is 422 VALIDATION_FAILED, and the field's own code is inside errors:

  {
    "status": 422,
    "code": "VALIDATION_FAILED",
    "title": "Validation failed",
    "detail": "One or more fields are invalid.",
    "request_id": "req_…",
    "errors": [
      { "field": "storage_gb", "code": "INVALID_DATABASE_STORAGE",
        "message": "must be at least the plan's disk size (or the zone's minimum), at most the zone's maximum, a multiple of the zone's step above the plan's size, and larger than the current size when resizing" }
    ]
  }

• A failed operation. The request was accepted (202), but the change could not be made. The operation ends failed, and its failure.code says why (with a readable failure.reason). For a new database the order carries a failure_code too, such as payment_expired (not paid within an hour) or organization_deleted (the organization was deleted first, so the order was cancelled and any payment returned to credit).

Quote request_id, or the operation's id, to support.

#Creating a database

Field codes, inside errors on a 422:

Other refusals:

An order can also end payment_failed or failed after it was accepted: see why an order failed.

#Reading and changing a database

#Security groups on a database

From PUT /databases/{database_id}/security-groups. Field codes, on security_group_ids:

From the security group's side:

A rule of an attached group that does not apply to the database is not an error: it is listed in the database's ignored_security_group_rules with a reason.

#Storage

From POST /databases/{database_id}/resize-storage:

A resize operation can fail with:

#Snapshots

From database snapshots:

#A VPS's private network interface

From POST and DELETE /instances/{instance_id}/private-network:

While a VPS has the interface, its security group is held to the same rule:

An attach or detach operation can fail with:

#Operations on a database

Other failure.codes a database operation can end with:

New codes may be added. Treat one you do not know by its HTTP status, or as a failed operation you can retry.