POST

/api/v1/backups/{id}/restore

Schedule restoration: verify the backup and restore it at the next Core start; back up the current state first

Request#

POSIX shell · curl

curl --fail-with-body --request POST \
  "$ADBR_API_URL/api/v1/backups/{id}/restore" \
  -H "Authorization: Bearer $ADBR_API_TOKEN" \
  -H "Content-Type: application/json" \
  --data '{}'

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#

Parameter	Location	Required	Description
`id`	path	Yes

Complete parameter schemas

OpenAPI JSON

[
  {
    "schema": {
      "type": "string",
      "minLength": 1,
      "maxLength": 64
    },
    "in": "path",
    "name": "id",
    "required": true
  }
]

Request body#

No request body declared.

Responses#

200 · Default response

OpenAPI JSON

{
  "description": "Default Response",
  "content": {
    "application/json": {
      "schema": {
        "type": "object",
        "required": [
          "pending_restore",
          "restart_required"
        ],
        "properties": {
          "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"
              }
            ]
          },
          "restart_required": {
            "type": "boolean"
          }
        }
      }
    }
  }
}

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": "Wiederherstellung vormerken: Die Sicherung wird geprüft und beim nächsten Core-Start eingespielt; der aktuelle Stand wird vorher gesichert",
  "tags": [
    "Sicherungen"
  ],
  "parameters": [
    {
      "schema": {
        "type": "string",
        "minLength": 1,
        "maxLength": 64
      },
      "in": "path",
      "name": "id",
      "required": true
    }
  ],
  "x-required-scopes": [
    "admin"
  ],
  "responses": {
    "200": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "required": [
              "pending_restore",
              "restart_required"
            ],
            "properties": {
              "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"
                  }
                ]
              },
              "restart_required": {
                "type": "boolean"
              }
            }
          }
        }
      }
    },
    "default": {
      "description": "HTTP error envelope. The status and error.code identify the failure.",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/Error"
          }
        }
      }
    }
  }
}