deploy.host-database.getShow a pooled app's pool-host database and its backups, newest first
Request syntax
GET /deploy/api/apps/{id}/host-databasePath parameters
idRequiredstring
Constraints: uuid
Response
200 with `data`: `database` (name, state, hostState, bytes, lastBackupAt, lastRestoreAt, backupPending, restorePending, lastError, limitMb, overLimit, limitProblem, createdAt; null when the app has none) and `backups` (each finished one: id, reason, bytes, createdAt, completedAt, expiresAt; newest first, at most 50). 400 for an app not on pooled hosting, 404 when the app is not the caller’s.
A JSON response is wrapped as { "success": true, "data": … }; the CLI prints the whole body with --json.
Fields of data
databaseAlwaysobject, may be null
The app’s pool-host database; null if it has nonedatabase.nameAlwaysstring
Name of the database and its role on the host (app_ and 12 hex)database.stateAlwaysone of active, dropping, dropped
active; dropping once moved or deleted, until the host has dropped itdatabase.hostStateAlwaysone of provisioning, ready, draining, lost, may be null
State of the pool host it lives on; null until the app is placeddatabase.bytesAlwaysnumber, may be null
Size as last reported, in bytes; null if not yetdatabase.lastBackupAtAlwaysstring, may be null
When it was last backed up; null if neverdatabase.lastRestoreAtAlwaysstring, may be null
When a backup was last restored; null if neverdatabase.backupPendingAlwaysboolean
Whether a backup was asked for and not yet takendatabase.restorePendingAlwaysboolean
Whether a restore was asked for and not yet donedatabase.lastErrorAlwaysstring, may be null
The host’s last error with it; null if nonedatabase.limitMbAlwaysnumber
Its size limit in MiB; over it the database is read onlydatabase.overLimitAlwaysboolean
Whether the pool host found it over its limit and made it read onlydatabase.limitProblemAlwaysstring, may be null
While it is over its limit: what happened and what to do; otherwise nulldatabase.createdAtAlwaysstring
When it was addedbackupsAlwaysarray of object
Its finished backups, newest first (at most 50)backups[].idAlwaysstring
Backup id, for restorebackups[].reasonAlwaysone of daily, manual, before-delete, before-restore, move
Why it was takenbackups[].bytesAlwaysnumber, may be null
Size of the dump, in bytesbackups[].createdAtAlwaysstring
When it was asked forbackups[].completedAtAlwaysstring, may be null
When it was finishedbackups[].expiresAtAlwaysstring
When it is deleted
Checked against the handlers: every route test validates their answers against this schema.
Errors
- 400The request does not pass the schema above. The body is { "error": …, "issues": […] }, one issue per field.
- 401No credentials, or an access key that is unknown, revoked or expired.
- 403The caller's policies do not allow deploy:DescribeApp on this resource. The body names the action and the resource, and the refusal is recorded in the audit log.
- 404The resource does not exist in your organization.
Examples
The required parameters only, with example values. Replace id and the other placeholders with your own.
dcloud deploy host-database get idcurl -X GET "https://console.platform-development.deutschecloud.app/deploy/api/apps/id/host-database" \
-H "Authorization: EWS-ACCESS-KEY $ACCESS_KEY"Generated from the API description, the same one the API checks requests against and the CLI is built from. MCP tool: dcloud_deploy_host-database_get.