Get a database export
const url = 'http://localhost:8000/clusters/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/exports/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0';
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/exports/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0 \
--header 'API-Key: <API-Key>' \
--header 'API-Version: 2026-06-01.beta'Returns a single export. Poll this endpoint to observe status and progress until the export is completed or failed.
Required scope: clusters:exports:read
Authorizations
Section titled “Authorizations”Parameters
Section titled “Parameters”Path Parameters
Section titled “Path Parameters”Header Parameters
Section titled “Header Parameters”Responses
Section titled “Responses”The request has succeeded.
object
When the archive will be deleted from storage.
Completion percentage of the export job, from 0 to 100.
Whether the dump includes the credential and related Keycloak tables.
Whether the archive is AES-256-CBC encrypted with the password provided at creation time.
Size of the produced ZIP archive in bytes. Only set once status is completed.
SHA-256 checksum of the produced ZIP archive (hex). Only set once status is completed.
Time-limited presigned URL to download the archive. Only set when status is completed and expires_at is in the future. Returned URLs are valid for at least one hour.
Failure description. Only set when status is failed.
Example
{
"id": "5fa3e1a0-2c9b-4d2f-9b3a-1e8c4d2f9b3a",
"cluster_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
"format": "pgdump",
"status": "completed",
"progress": 100,
"include_credentials": false,
"is_encrypted": false,
"file_size_bytes": 4823104,
"sha256_checksum": "9f86d081884c7d659a2feaa0c55ad015a3bf4f1b2b0b822cd15d6c15b0f00a08",
"download_url": "https://exports.skycloak.io/.../export.zip?X-Amz-Signature=...",
"expires_at": "2026-04-29T10:15:00Z",
"error_message": null,
"created_at": "2026-04-28T10:00:00Z",
"started_at": "2026-04-28T10:00:05Z",
"completed_at": "2026-04-28T10:15: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"
}