GET

/api/v1/backups/full

Einstellungen und Stand des verschlüsselten Vollbackups (.adbbackup) und der Prüfung

Anfrage#

POSIX-Shell · curl

curl --fail-with-body --request GET \
  "$ADBR_API_URL/api/v1/backups/full" \
  -H "Authorization: Bearer $ADBR_API_TOKEN"

Verwende lokale Adresse und Token aus API & MCP. Ersetze Pfadplatzhalter wie {id} durch tatsächliche IDs.

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#

Kein Anfragekörper deklariert.

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": "Einstellungen und Stand des verschlüsselten Vollbackups (.adbbackup) und der Prüfung",
  "tags": [
    "Sicherungen"
  ],
  "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"
          }
        }
      }
    }
  }
}