skycloak_create_export
Starts an asynchronous database export for a cluster; poll the export status until completed to get the download URL. Including credentials requires an encryption password.
Instructions
Start a database export for a cluster. Asynchronous: poll skycloak_get_export until the status is 'completed' to obtain the download URL. Including credentials requires an encryption_password.
Tool call template
Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.
{
"id": 1,
"jsonrpc": "2.0",
"method": "tools/call",
"params": {
"arguments": {
"cluster_id": "<cluster_id>",
"format": "<format>"
},
"name": "skycloak_create_export"
}
}Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| format | Yes | export format: sql or pgdump (case-insensitive) | |
| cluster_id | Yes | the cluster ID | |
| encryption_password | No | password to encrypt the archive (AES-256-CBC); required when include_credentials is true | |
| include_credentials | No | include the Keycloak credential tables; requires encryption_password |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| id | Yes | ||
| format | Yes | ||
| status | Yes | ||
| progress | Yes | ||
| expires_at | No | ||
| completed_at | No | ||
| download_url | No | ||
| is_encrypted | Yes | ||
| error_message | No | ||
| file_size_bytes | No |