Get a backup
const url = 'http://localhost:8000/clusters/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/backups/example';
const options = {
method: 'GET',
headers: {'API-Version': '2026-06-01.beta', 'API-Key': '<API-Key>'}
};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}curl --request GET \
--url http://localhost:8000/clusters/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/backups/example \
--header 'API-Key: <API-Key>' \
--header 'API-Version: 2026-06-01.beta'Returns one backup.
Required scope: clusters:backups:read
Authorizations
Section titled “Authorizations”Parameters
Section titled “Parameters”Path Parameters
Section titled “Path Parameters”Backup identifier: auto-<yyyymmddhhmm> for an automatic backup, manual-<timestamp>-<suffix> for an on-demand one.
Header Parameters
Section titled “Header Parameters”Responses
Section titled “Responses”The request has succeeded.
object
Backup identifier: auto-<yyyymmddhhmm> for an automatic backup, manual-<timestamp>-<suffix> for an on-demand one.
Days the backup is kept after it completes.
Size of the stored backup in bytes. Set once status is completed.
SHA-256 of the stored (encrypted) object, hex. Set once status is completed.
Keycloak version whose database was backed up.
Machine-readable failure cause when status is failed: JobFailed, JobLost, Missed, BackupsDisabled, InvalidReport, DatabaseNotReady or StorageNotConfigured.
When the backup is deleted from storage.
When the backup was deleted from storage, for status deleted.
Example
{
"id": "auto-202609230300",
"cluster_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
"type": "automatic",
"status": "completed",
"retention_days": 14,
"size_bytes": 52428800,
"sha256": "9f86d081884c7d659a2feaa0c55ad015a3bf4f1b2b0b822cd15d6c15b0f00a08",
"keycloak_version": "26.3.0",
"requested_at": "2026-09-23T03:00:00Z",
"started_at": "2026-09-23T03:00:04Z",
"completed_at": "2026-09-23T03:04:12Z",
"expires_at": "2026-10-07T03:04:12Z",
"created_at": "2026-09-23T03:00:00Z"
}Access is unauthorized.
RFC 9457 Problem Details object.
object
Example generated
{
"type": "https://example.com",
"title": "example",
"status": 1,
"detail": "example",
"instance": "https://example.com"
}Access is forbidden.
RFC 9457 Problem Details object.
object
Example generated
{
"type": "https://example.com",
"title": "example",
"status": 1,
"detail": "example",
"instance": "https://example.com"
}The server cannot find the requested resource.
RFC 9457 Problem Details object.
object
Example generated
{
"type": "https://example.com",
"title": "example",
"status": 1,
"detail": "example",
"instance": "https://example.com"
}Client error
RFC 9457 Problem Details object.
object
Example generated
{
"type": "https://example.com",
"title": "example",
"status": 1,
"detail": "example",
"instance": "https://example.com"
}Headers
Section titled “Headers”Server error
RFC 9457 Problem Details object.
object
Example generated
{
"type": "https://example.com",
"title": "example",
"status": 1,
"detail": "example",
"instance": "https://example.com"
}Server error
RFC 9457 Problem Details object.
object
Example generated
{
"type": "https://example.com",
"title": "example",
"status": 1,
"detail": "example",
"instance": "https://example.com"
}