POST

/api/v1/backups/full

Vollbackup jetzt erstellen: alle Profile portabel, Proxys, Gruppen, Tags, Erweiterungsbibliothek und RPA-Abläufe; verschlüsselt, geprüft und erst dann in den Zielordner verschoben

Anfrage#

POSIX-Shell · curl

curl --fail-with-body --request POST \
  "$ADBR_API_URL/api/v1/backups/full" \
  -H "Authorization: Bearer $ADBR_API_TOKEN" \
  -H "Content-Type: application/json" \
  --data @request.json

Verwende 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
`target_dir`	`string`	Nein
`password`	`string`	Nein

Vollständiges Körperschema

OpenAPI JSON

{
  "required": true,
  "content": {
    "application/json": {
      "schema": {
        "type": "object",
        "properties": {
          "target_dir": {
            "type": "string",
            "minLength": 3,
            "maxLength": 1024
          },
          "password": {
            "type": "string",
            "minLength": 1,
            "maxLength": 1024
          }
        },
        "additionalProperties": false
      }
    }
  }
}

Antworten#

200 · Standardantwort

OpenAPI JSON

{
  "description": "Default Response",
  "content": {
    "application/json": {
      "schema": {
        "type": "object",
        "required": [
          "path",
          "size_bytes",
          "sha256",
          "proxies",
          "groups",
          "tags",
          "extensions",
          "extension_sets",
          "workflows",
          "pruned",
          "warnings",
          "profiles"
        ],
        "properties": {
          "path": {
            "type": "string"
          },
          "size_bytes": {
            "type": "integer"
          },
          "sha256": {
            "type": "string"
          },
          "proxies": {
            "type": "integer"
          },
          "groups": {
            "type": "integer"
          },
          "tags": {
            "type": "integer"
          },
          "extensions": {
            "type": "integer"
          },
          "extension_sets": {
            "type": "integer"
          },
          "workflows": {
            "type": "integer"
          },
          "pruned": {
            "type": "integer"
          },
          "warnings": {
            "type": "array",
            "items": {
              "type": "string"
            }
          },
          "profiles": {
            "type": "array",
            "items": {
              "type": "object",
              "required": [
                "id",
                "no",
                "name",
                "cookies",
                "files",
                "warnings"
              ],
              "properties": {
                "id": {
                  "type": "string"
                },
                "no": {
                  "type": "integer"
                },
                "name": {
                  "type": "string"
                },
                "cookies": {
                  "type": [
                    "null",
                    "integer"
                  ]
                },
                "files": {
                  "type": "integer"
                },
                "warnings": {
                  "type": "array",
                  "items": {
                    "type": "string"
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}

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": "Vollbackup jetzt erstellen: alle Profile portabel, Proxys, Gruppen, Tags, Erweiterungsbibliothek und RPA-Abläufe; verschlüsselt, geprüft und erst dann in den Zielordner verschoben",
  "tags": [
    "Sicherungen"
  ],
  "requestBody": {
    "required": true,
    "content": {
      "application/json": {
        "schema": {
          "type": "object",
          "properties": {
            "target_dir": {
              "type": "string",
              "minLength": 3,
              "maxLength": 1024
            },
            "password": {
              "type": "string",
              "minLength": 1,
              "maxLength": 1024
            }
          },
          "additionalProperties": false
        }
      }
    }
  },
  "x-required-scopes": [
    "admin"
  ],
  "responses": {
    "200": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "required": [
              "path",
              "size_bytes",
              "sha256",
              "proxies",
              "groups",
              "tags",
              "extensions",
              "extension_sets",
              "workflows",
              "pruned",
              "warnings",
              "profiles"
            ],
            "properties": {
              "path": {
                "type": "string"
              },
              "size_bytes": {
                "type": "integer"
              },
              "sha256": {
                "type": "string"
              },
              "proxies": {
                "type": "integer"
              },
              "groups": {
                "type": "integer"
              },
              "tags": {
                "type": "integer"
              },
              "extensions": {
                "type": "integer"
              },
              "extension_sets": {
                "type": "integer"
              },
              "workflows": {
                "type": "integer"
              },
              "pruned": {
                "type": "integer"
              },
              "warnings": {
                "type": "array",
                "items": {
                  "type": "string"
                }
              },
              "profiles": {
                "type": "array",
                "items": {
                  "type": "object",
                  "required": [
                    "id",
                    "no",
                    "name",
                    "cookies",
                    "files",
                    "warnings"
                  ],
                  "properties": {
                    "id": {
                      "type": "string"
                    },
                    "no": {
                      "type": "integer"
                    },
                    "name": {
                      "type": "string"
                    },
                    "cookies": {
                      "type": [
                        "null",
                        "integer"
                      ]
                    },
                    "files": {
                      "type": "integer"
                    },
                    "warnings": {
                      "type": "array",
                      "items": {
                        "type": "string"
                      }
                    }
                  }
                }
              }
            }
          }
        }
      }
    },
    "default": {
      "description": "HTTP error envelope. The status and error.code identify the failure.",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/Error"
          }
        }
      }
    }
  }
}