Skip to content

Lists all backups

get/v1/projects/{ref}/database/backups

OAuth scopes

  • database:read

The fine-grained token must include the following permissions to access this endpoint:

  • backups_read

Path parameters

  • ref
    Required
    string

    Project ref

Response codes

  • 200
  • 401
  • 403
  • 429
  • 500

Response (200)

{
"region": "lorem",
"walg_enabled": true,
"pitr_enabled": true,
"backups": [
{
"id": -9007199254740991,
"is_physical_backup": true,
"status": "COMPLETED",
"inserted_at": "lorem"
}
],
"physical_backup_data": {
"earliest_physical_backup_date_unix": -9007199254740991,
"latest_physical_backup_date_unix": -9007199254740991
}
}
{
"type": "object",
"properties": {
"region": {
"type": "string"
},
"walg_enabled": {
"type": "boolean"
},
"pitr_enabled": {
"type": "boolean"
},
"backups": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"is_physical_backup": {
"type": "boolean"
},
"status": {
"type": "string",
"enum": [
"COMPLETED",
"FAILED",
"PENDING",
"REMOVED",
"ARCHIVED",
"CANCELLED"
]
},
"inserted_at": {
"type": "string"
}
},
"required": [
"id",
"is_physical_backup",
"status",
"inserted_at"
]
}
},
"physical_backup_data": {
"type": "object",
"properties": {
"earliest_physical_backup_date_unix": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"latest_physical_backup_date_unix": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
}
}
}
},
"required": [
"region",
"walg_enabled",
"pitr_enabled",
"backups",
"physical_backup_data"
]
}