Documentation / Backups / Endpoint
GET

/api/v1/backups

Database backups (daily, before migrations, before bulk changes)

Request#

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

Use the local address and token from API & MCP. Replace path placeholders such as {id} with actual IDs.

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#

No request body declared.

Responses#

200 · Default response
OpenAPI JSON
{
  "description": "Default Response",
  "content": {
    "application/json": {
      "schema": {
        "type": "object",
        "required": [
          "items",
          "pending_restore"
        ],
        "properties": {
          "items": {
            "type": "array",
            "items": {
              "type": "object",
              "required": [
                "id",
                "kind",
                "file_name",
                "path",
                "size_bytes",
                "created_at",
                "note",
                "exists"
              ],
              "properties": {
                "id": {
                  "type": "string"
                },
                "kind": {
                  "type": "string"
                },
                "file_name": {
                  "type": "string"
                },
                "path": {
                  "type": "string"
                },
                "size_bytes": {
                  "type": "integer"
                },
                "created_at": {
                  "type": "integer"
                },
                "note": {
                  "type": [
                    "null",
                    "string"
                  ]
                },
                "exists": {
                  "type": "boolean"
                }
              }
            }
          },
          "pending_restore": {
            "anyOf": [
              {
                "type": "object",
                "required": [
                  "backup_id",
                  "file",
                  "created_at",
                  "requested_at"
                ],
                "properties": {
                  "backup_id": {
                    "type": "string"
                  },
                  "file": {
                    "type": "string"
                  },
                  "created_at": {
                    "type": "integer"
                  },
                  "requested_at": {
                    "type": "integer"
                  }
                }
              },
              {
                "type": "null"
              }
            ]
          }
        }
      }
    }
  }
}
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": "Datenbanksicherungen (täglich, vor Migrationen, vor Massenänderungen)",
  "tags": [
    "Sicherungen"
  ],
  "x-required-scopes": [
    "admin"
  ],
  "responses": {
    "200": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "required": [
              "items",
              "pending_restore"
            ],
            "properties": {
              "items": {
                "type": "array",
                "items": {
                  "type": "object",
                  "required": [
                    "id",
                    "kind",
                    "file_name",
                    "path",
                    "size_bytes",
                    "created_at",
                    "note",
                    "exists"
                  ],
                  "properties": {
                    "id": {
                      "type": "string"
                    },
                    "kind": {
                      "type": "string"
                    },
                    "file_name": {
                      "type": "string"
                    },
                    "path": {
                      "type": "string"
                    },
                    "size_bytes": {
                      "type": "integer"
                    },
                    "created_at": {
                      "type": "integer"
                    },
                    "note": {
                      "type": [
                        "null",
                        "string"
                      ]
                    },
                    "exists": {
                      "type": "boolean"
                    }
                  }
                }
              },
              "pending_restore": {
                "anyOf": [
                  {
                    "type": "object",
                    "required": [
                      "backup_id",
                      "file",
                      "created_at",
                      "requested_at"
                    ],
                    "properties": {
                      "backup_id": {
                        "type": "string"
                      },
                      "file": {
                        "type": "string"
                      },
                      "created_at": {
                        "type": "integer"
                      },
                      "requested_at": {
                        "type": "integer"
                      }
                    }
                  },
                  {
                    "type": "null"
                  }
                ]
              }
            }
          }
        }
      }
    },
    "default": {
      "description": "HTTP error envelope. The status and error.code identify the failure.",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/Error"
          }
        }
      }
    }
  }
}

Search for headless, MCP, cookies or an API endpoint.

↑ ↓ NavigateEnter OpenEsc Close