Backups and restore

All paths below use https://api.lordbase.com. Read conventions for headers, authentication, pagination and error handling. Values in responses are illustrative; examples show selected fields, not fixed quotas or service guarantees.

Developer tokens authorize only explicitly supported operations. Required scopes appear below; account, billing and token-management operations require a dashboard session. See token permissions.

List or request backups — GET

GET /e/v1/developer/databases/{database_id}/backups/

Authentication: Authenticated developer with an active Lordbase subscription. Use the dashboard session, or Authorization: Bearer YOUR_DEVELOPER_TOKEN with read_backups (or api). Resource roles and quotas still apply.

Request and permissions: Workspace member. Optional limit/offset pagination.

Required path parameters: database_id (UUID).

Response: 200

{
  "count": 1,
  "limit": 20,
  "offset": 0,
  "results": [
    {
      "id": "11111111-1111-4111-8111-111111111111",
      "database": "11111111-1111-4111-8111-111111111111",
      "name": "Before migration",
      "backup_type": "manual",
      "status": "completed",
      "file_size_bytes": 4096,
      "file_size_mb": 0.00390625,
      "error_message": "",
      "is_expired": false,
      "expires_at": "2026-11-03T12:00:00Z"
    }
  ]
}

Failures: Common API errors, plus the validation, role, state, engine and plan restrictions stated above.

List or request backups — POST

POST /e/v1/developer/databases/{database_id}/backups/

Authentication: Authenticated developer with an active Lordbase subscription. Use the dashboard session, or Authorization: Bearer YOUR_DEVELOPER_TOKEN with write_backups (or api). Resource roles and quotas still apply.

Request and permissions: Workspace member; active database. Optional JSON name string. 201 creates a pending job, not a completed backup. Poll the backup detail until completed or failed. Engine-specific recovery restrictions apply; see the backup guide.

Required path parameters: database_id (UUID).

Example JSON body:

{
  "name": "Before migration"
}

Response: 201

{
  "id": "11111111-1111-4111-8111-111111111111",
  "database": "11111111-1111-4111-8111-111111111111",
  "name": "Before migration",
  "backup_type": "manual",
  "status": "pending",
  "file_size_bytes": 0,
  "file_size_mb": 0,
  "error_message": "",
  "is_expired": false,
  "expires_at": "2026-11-03T12:00:00Z"
}

Failures: Common API errors, plus the validation, role, state, engine and plan restrictions stated above.

Inspect or delete a backup — GET

GET /e/v1/developer/backups/{backup_id}/

Authentication: Authenticated developer with an active Lordbase subscription. Use the dashboard session, or Authorization: Bearer YOUR_DEVELOPER_TOKEN with read_backups (or api). Resource roles and quotas still apply.

Request and permissions: Workspace member; no body. Inspect status, error_message, expires_at and is_expired.

Required path parameters: backup_id (UUID).

Response: 200

{
  "id": "11111111-1111-4111-8111-111111111111",
  "database": "11111111-1111-4111-8111-111111111111",
  "name": "Before migration",
  "backup_type": "manual",
  "status": "completed",
  "file_size_bytes": 4096,
  "file_size_mb": 0.00390625,
  "error_message": "",
  "is_expired": false,
  "expires_at": "2026-11-03T12:00:00Z"
}

Failures: Common API errors, plus the validation, role, state, engine and plan restrictions stated above.

Inspect or delete a backup — DELETE

DELETE /e/v1/developer/backups/{backup_id}/

Authentication: Authenticated developer with an active Lordbase subscription. Use the dashboard session, or Authorization: Bearer YOUR_DEVELOPER_TOKEN with write_backups (or api). Resource roles and quotas still apply.

Request and permissions: Workspace member; no body. Deletes the stored recovery artifact and metadata; this is destructive.

Required path parameters: backup_id (UUID).

Response: 204

Empty body. Do not parse JSON for this response.

Failures: Common API errors, plus the validation, role, state, engine and plan restrictions stated above.

Start a backup restore — POST

POST /e/v1/developer/backups/{backup_id}/restore/

Authentication: Authenticated developer with an active Lordbase subscription. Use the dashboard session, or Authorization: Bearer YOUR_DEVELOPER_TOKEN with write_backups and write_databases (or api). Resource roles and quotas still apply.

Request and permissions: Membership in source and target workspaces; completed supported backup and active target with the same engine. JSON target_database_id UUID is optional; omitted means restore over the source. Restore changes target data. The operation is asynchronous: poll the returned job ID. A timeout does not prove rollback.

Required path parameters: backup_id (UUID).

Example JSON body:

{
  "target_database_id": "11111111-1111-4111-8111-111111111111"
}

Response: 202

{
  "id": "11111111-1111-4111-8111-111111111111",
  "status": "pending",
  "target_database": "11111111-1111-4111-8111-111111111111"
}

Failures: Common API errors, plus the validation, role, state, engine and plan restrictions stated above.

Read restore job status — GET

GET /e/v1/developer/backup-restores/{restore_id}/

Authentication: Authenticated developer with an active Lordbase subscription. Use the dashboard session, or Authorization: Bearer YOUR_DEVELOPER_TOKEN with read_backups (or api). Resource roles and quotas still apply.

Request and permissions: Membership in both source and target workspaces; no body. Poll until completed or failed and inspect error details.

Required path parameters: restore_id (UUID).

Response: 200

{
  "id": "11111111-1111-4111-8111-111111111111",
  "status": "completed",
  "target_database": "11111111-1111-4111-8111-111111111111"
}

Failures: Common API errors, plus the validation, role, state, engine and plan restrictions stated above.