Backup schedules

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 create backup schedules — GET

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

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.

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": "Daily recovery",
      "frequency": "daily",
      "hour": 2,
      "minute": 0,
      "day_of_week": null,
      "day_of_month": null,
      "retention_count": 7,
      "is_active": true,
      "next_run_at": "2026-10-28T02:00:00Z",
      "last_run_status": ""
    }
  ]
}

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

List or create backup schedules — POST

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

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: Owner/admin; active or paused database. JSON name optional; frequency is hourly/daily/weekly/monthly (default daily); hour 0..23 (default 3), minute 0..59 (default 0); weekly requires day_of_week 0..6 (Monday0); monthly requires day_of_month 1..28. retention_count 1..365 (default 7) is capped by plan; is_active boolean defaults true. Times use UTC. Database ID is assigned from the path. Paused databases do not run backups.

Required path parameters: database_id (UUID).

Field reference: BackupSchedule. The operation above defines which fields to send.

Example JSON body:

{
  "name": "Daily recovery",
  "frequency": "daily",
  "hour": 2,
  "minute": 0,
  "retention_count": 7
}

Response: 201

{
  "id": "11111111-1111-4111-8111-111111111111",
  "database": "11111111-1111-4111-8111-111111111111",
  "name": "Daily recovery",
  "frequency": "daily",
  "hour": 2,
  "minute": 0,
  "day_of_week": null,
  "day_of_month": null,
  "retention_count": 7,
  "is_active": true,
  "next_run_at": "2026-10-28T02:00:00Z",
  "last_run_status": ""
}

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

Read, update or remove a schedule — GET

GET /e/v1/developer/schedules/{schedule_id}/

Request and permissions: Workspace member; no body.

Required path parameters: schedule_id (UUID).

Response: 200

{
  "id": "11111111-1111-4111-8111-111111111111",
  "database": "11111111-1111-4111-8111-111111111111",
  "name": "Daily recovery",
  "frequency": "daily",
  "hour": 2,
  "minute": 0,
  "day_of_week": null,
  "day_of_month": null,
  "retention_count": 7,
  "is_active": true,
  "next_run_at": "2026-10-28T02:00:00Z",
  "last_run_status": ""
}

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

Read, update or remove a schedule — PATCH

PATCH /e/v1/developer/schedules/{schedule_id}/

Request and permissions: Owner/admin. Partial schedule fields; frequency-dependent day requirements and plan retention still apply. Do not reassign database. Active schedules recalculate next_run_at.

Required path parameters: schedule_id (UUID).

Field reference: BackupSchedule. The operation above defines which fields to send.

Example JSON body:

{
  "is_active": false
}

Response: 200

{
  "id": "11111111-1111-4111-8111-111111111111",
  "database": "11111111-1111-4111-8111-111111111111",
  "name": "Daily recovery",
  "frequency": "daily",
  "hour": 2,
  "minute": 0,
  "day_of_week": null,
  "day_of_month": null,
  "retention_count": 7,
  "is_active": true,
  "next_run_at": "2026-10-28T02:00:00Z",
  "last_run_status": ""
}

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

Read, update or remove a schedule — DELETE

DELETE /e/v1/developer/schedules/{schedule_id}/

Request and permissions: Owner/admin; no body. Removes the schedule, not necessarily its existing backups.

Required path parameters: schedule_id (UUID).

Response: 200

{
  "message": "Schedule 'Daily recovery' deleted"
}

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

Trigger a schedule now — POST

POST /e/v1/developer/schedules/{schedule_id}/trigger/

Request and permissions: Owner/admin; active database; no body. Queues work and returns 200; poll backups and last_run_status. If the schedule is disabled, background execution may skip it.

Required path parameters: schedule_id (UUID).

Response: 200

{
  "message": "Backup triggered successfully",
  "schedule_id": "11111111-1111-4111-8111-111111111111"
}

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

List or create backup schedules — GET​

List or create backup schedules — POST​

Read, update or remove a schedule — GET​

Read, update or remove a schedule — PATCH​

Read, update or remove a schedule — DELETE​

Trigger a schedule now — POST​

List or create backup schedules — GET

List or create backup schedules — POST

Read, update or remove a schedule — GET

Read, update or remove a schedule — PATCH

Read, update or remove a schedule — DELETE

Trigger a schedule now — POST