Skip to main content

AppdataBackupContainer

namestringrequired
imagestringrequired

The container's image repository, without its tag.

runningbooleanrequired
stopbooleanrequired

Whether the backup stops the container while its appdata is copied. Only a running container is stopped.

includedbooleanrequired
databaseImagebooleanrequired

Whether the image is a known database (Postgres, MariaDB, MySQL, MongoDB, Redis and similar).

warningstring | nullnullable

Present when a known database image is included but not stopped.

AppdataBackupContainer
{
"name": "string",
"image": "string",
"running": true,
"stop": true,
"included": true,
"databaseImage": true,
"warning": "string"
}