TabGeckoPUT
/api/v1/backups/full/settings
Configure full backup schedule, destination folder, and saved password (password stored in the vault)
Request#
POSIX shell · curl
curl --fail-with-body --request PUT \
"$ADBR_API_URL/api/v1/backups/full/settings" \
-H "Authorization: Bearer $ADBR_API_TOKEN" \
-H "Content-Type: application/json" \
--data @request.jsonUse the local address and token from API & MCP. Replace path placeholders such as {id} with actual IDs. Create request.json according to the body schema below before running this command.
Authentication and permissions#
Authentication: Bearer token
Scopes: admin
All listed scopes are required; admin satisfies scope checks. Account permissions, request content, vault state and resource permissions can impose additional requirements.
Parameters#
No path or query parameters declared.
Request body#
Required.
| Field | Type | Required | Description |
|---|---|---|---|
schedule | union | No | |
target_dir | string | null | No | |
include_cookies | boolean | No | |
password | string | No | |
clear_password | boolean | No |
Complete body schema
OpenAPI JSON
{
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"schedule": {
"anyOf": [
{
"type": "string",
"enum": [
"off"
]
},
{
"type": "string",
"enum": [
"daily"
]
},
{
"type": "string",
"enum": [
"weekly"
]
}
]
},
"target_dir": {
"type": [
"string",
"null"
],
"minLength": 3,
"maxLength": 1024
},
"include_cookies": {
"type": "boolean"
},
"password": {
"type": "string",
"minLength": 12,
"maxLength": 1024
},
"clear_password": {
"type": "boolean"
}
},
"additionalProperties": false
}
}
}
}Responses#
200 · Default response
OpenAPI JSON
{
"description": "Default Response",
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"schedule",
"target_dir",
"include_cookies",
"password_stored",
"running",
"last_run",
"last_success_at",
"next_due_at",
"last_verify",
"last_verify_ok_at"
],
"properties": {
"schedule": {
"type": "string"
},
"target_dir": {
"type": [
"null",
"string"
]
},
"include_cookies": {
"type": "boolean"
},
"password_stored": {
"type": "boolean"
},
"running": {
"type": "boolean"
},
"last_run": {
"anyOf": [
{
"type": "object",
"required": [
"at",
"ok",
"trigger",
"path",
"size_bytes",
"profiles",
"warnings",
"pruned",
"error"
],
"properties": {
"at": {
"type": "integer"
},
"ok": {
"type": "boolean"
},
"trigger": {
"type": "string"
},
"path": {
"type": [
"string",
"null"
]
},
"size_bytes": {
"type": [
"integer",
"null"
]
},
"profiles": {
"type": [
"integer",
"null"
]
},
"warnings": {
"type": "integer"
},
"pruned": {
"type": "integer"
},
"error": {
"type": [
"string",
"null"
]
}
}
},
{
"type": "null"
}
]
},
"last_success_at": {
"type": [
"null",
"integer"
]
},
"next_due_at": {
"type": [
"null",
"integer"
]
},
"last_verify": {
"anyOf": [
{
"type": "object",
"required": [
"at",
"ok",
"db",
"full"
],
"properties": {
"at": {
"type": "integer"
},
"ok": {
"type": "boolean"
},
"db": {
"type": "object",
"required": [
"file",
"ok",
"profiles",
"error"
],
"properties": {
"file": {
"type": [
"null",
"string"
]
},
"ok": {
"type": [
"null",
"boolean"
]
},
"profiles": {
"type": [
"null",
"integer"
]
},
"error": {
"type": [
"null",
"string"
]
}
}
},
"full": {
"type": "object",
"required": [
"file",
"ok",
"profiles",
"error"
],
"properties": {
"file": {
"type": [
"null",
"string"
]
},
"ok": {
"type": [
"null",
"boolean"
]
},
"profiles": {
"type": [
"null",
"integer"
]
},
"error": {
"type": [
"null",
"string"
]
}
}
}
}
},
{
"type": "null"
}
]
},
"last_verify_ok_at": {
"type": [
"null",
"integer"
]
}
}
}
}
}
}default · HTTP error envelope. The status and error.code identify the failure.
OpenAPI JSON
{
"description": "HTTP error envelope. The status and error.code identify the failure.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}General authentication and transport errors may occur in addition to the documented responses.
OpenAPI definition#
Complete operation definition
OpenAPI JSON
{
"summary": "Zeitplan, Zielordner und gespeichertes Passwort für Vollbackups festlegen (Passwort liegt dann im Tresor)",
"tags": [
"Sicherungen"
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"schedule": {
"anyOf": [
{
"type": "string",
"enum": [
"off"
]
},
{
"type": "string",
"enum": [
"daily"
]
},
{
"type": "string",
"enum": [
"weekly"
]
}
]
},
"target_dir": {
"type": [
"string",
"null"
],
"minLength": 3,
"maxLength": 1024
},
"include_cookies": {
"type": "boolean"
},
"password": {
"type": "string",
"minLength": 12,
"maxLength": 1024
},
"clear_password": {
"type": "boolean"
}
},
"additionalProperties": false
}
}
}
},
"x-required-scopes": [
"admin"
],
"responses": {
"200": {
"description": "Default Response",
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"schedule",
"target_dir",
"include_cookies",
"password_stored",
"running",
"last_run",
"last_success_at",
"next_due_at",
"last_verify",
"last_verify_ok_at"
],
"properties": {
"schedule": {
"type": "string"
},
"target_dir": {
"type": [
"null",
"string"
]
},
"include_cookies": {
"type": "boolean"
},
"password_stored": {
"type": "boolean"
},
"running": {
"type": "boolean"
},
"last_run": {
"anyOf": [
{
"type": "object",
"required": [
"at",
"ok",
"trigger",
"path",
"size_bytes",
"profiles",
"warnings",
"pruned",
"error"
],
"properties": {
"at": {
"type": "integer"
},
"ok": {
"type": "boolean"
},
"trigger": {
"type": "string"
},
"path": {
"type": [
"string",
"null"
]
},
"size_bytes": {
"type": [
"integer",
"null"
]
},
"profiles": {
"type": [
"integer",
"null"
]
},
"warnings": {
"type": "integer"
},
"pruned": {
"type": "integer"
},
"error": {
"type": [
"string",
"null"
]
}
}
},
{
"type": "null"
}
]
},
"last_success_at": {
"type": [
"null",
"integer"
]
},
"next_due_at": {
"type": [
"null",
"integer"
]
},
"last_verify": {
"anyOf": [
{
"type": "object",
"required": [
"at",
"ok",
"db",
"full"
],
"properties": {
"at": {
"type": "integer"
},
"ok": {
"type": "boolean"
},
"db": {
"type": "object",
"required": [
"file",
"ok",
"profiles",
"error"
],
"properties": {
"file": {
"type": [
"null",
"string"
]
},
"ok": {
"type": [
"null",
"boolean"
]
},
"profiles": {
"type": [
"null",
"integer"
]
},
"error": {
"type": [
"null",
"string"
]
}
}
},
"full": {
"type": "object",
"required": [
"file",
"ok",
"profiles",
"error"
],
"properties": {
"file": {
"type": [
"null",
"string"
]
},
"ok": {
"type": [
"null",
"boolean"
]
},
"profiles": {
"type": [
"null",
"integer"
]
},
"error": {
"type": [
"null",
"string"
]
}
}
}
}
},
{
"type": "null"
}
]
},
"last_verify_ok_at": {
"type": [
"null",
"integer"
]
}
}
}
}
}
},
"default": {
"description": "HTTP error envelope. The status and error.code identify the failure.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
}
}