TabGeckoPUT
/api/v1/backups/full/settings
Zeitplan, Zielordner und gespeichertes Passwort für Vollbackups festlegen (Passwort liegt dann im Tresor)
Anfrage#
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.jsonVerwende lokale Adresse und Token aus API & MCP. Ersetze Pfadplatzhalter wie {id} durch tatsächliche IDs. Erstelle request.json anhand des folgenden Körperschemas, bevor du den Befehl ausführst.
Authentifizierung und Rechte#
Authentifizierung: Bearer-Token
Scopes: admin
Alle aufgeführten Scopes sind erforderlich; admin erfüllt Scope-Prüfungen. Kontorechte, Anfrageinhalt, Tresorzustand und Ressourcenrechte können weitere Voraussetzungen setzen.
Parameter#
Keine Pfad- oder Query-Parameter deklariert.
Anfragekörper#
Erforderlich.
| Feld | Typ | Pflicht | Beschreibung |
|---|---|---|---|
schedule | union | Nein | |
target_dir | string | null | Nein | |
include_cookies | boolean | Nein | |
password | string | Nein | |
clear_password | boolean | Nein |
Vollständiges Körperschema
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
}
}
}
}Antworten#
200 · Standardantwort
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-Fehlerhülle. Status und error.code bezeichnen den Fehler.
OpenAPI JSON
{
"description": "HTTP error envelope. The status and error.code identify the failure.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}Allgemeine Authentifizierungs- und Transportfehler können zusätzlich zu den dokumentierten Antworten auftreten.
OpenAPI-Definition#
Vollständige Operationsdefinition
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"
}
}
}
}
}
}