POST

/api/v1/profiles/{id}/snapshots/{snapshotId}/restore

Restore a snapshot; back up the current state first and set engine_build_last_used to the snapshot’s build

Request#

POSIX shell · curl

curl --fail-with-body --request POST \
  "$ADBR_API_URL/api/v1/profiles/{id}/snapshots/{snapshotId}/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: profiles:write

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
`operation_id`	query	No
`id`	path	Yes
`snapshotId`	path	Yes

Complete parameter schemas

OpenAPI JSON

[
  {
    "schema": {
      "type": "string",
      "pattern": "^[a-zA-Z0-9-]{16,64}$"
    },
    "in": "query",
    "name": "operation_id",
    "required": false
  },
  {
    "schema": {
      "type": "string"
    },
    "in": "path",
    "name": "id",
    "required": true
  },
  {
    "schema": {
      "type": "string"
    },
    "in": "path",
    "name": "snapshotId",
    "required": true
  }
]

Request body#

No request body declared.

Responses#

200 · Default response

OpenAPI JSON

{
  "description": "Default Response",
  "content": {
    "application/json": {
      "schema": {
        "type": "object",
        "required": [
          "restored",
          "safety"
        ],
        "properties": {
          "restored": {
            "type": "object",
            "required": [
              "id",
              "profile_id",
              "reason",
              "file_name",
              "size_bytes",
              "engine_build",
              "created_at",
              "exists"
            ],
            "properties": {
              "id": {
                "type": "string"
              },
              "profile_id": {
                "type": "string"
              },
              "reason": {
                "type": "string"
              },
              "file_name": {
                "type": "string"
              },
              "size_bytes": {
                "type": "integer"
              },
              "engine_build": {
                "type": "string"
              },
              "created_at": {
                "type": "integer"
              },
              "exists": {
                "type": "boolean"
              }
            }
          },
          "safety": {
            "type": "object",
            "required": [
              "id",
              "profile_id",
              "reason",
              "file_name",
              "size_bytes",
              "engine_build",
              "created_at",
              "exists"
            ],
            "properties": {
              "id": {
                "type": "string"
              },
              "profile_id": {
                "type": "string"
              },
              "reason": {
                "type": "string"
              },
              "file_name": {
                "type": "string"
              },
              "size_bytes": {
                "type": "integer"
              },
              "engine_build": {
                "type": "string"
              },
              "created_at": {
                "type": "integer"
              },
              "exists": {
                "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": "Snapshot wiederherstellen; vorher wird der aktuelle Stand gesichert, engine_build_last_used wird auf den Build des Snapshots gesetzt",
  "tags": [
    "Snapshots"
  ],
  "parameters": [
    {
      "schema": {
        "type": "string",
        "pattern": "^[a-zA-Z0-9-]{16,64}$"
      },
      "in": "query",
      "name": "operation_id",
      "required": false
    },
    {
      "schema": {
        "type": "string"
      },
      "in": "path",
      "name": "id",
      "required": true
    },
    {
      "schema": {
        "type": "string"
      },
      "in": "path",
      "name": "snapshotId",
      "required": true
    }
  ],
  "x-required-scopes": [
    "profiles:write"
  ],
  "responses": {
    "200": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "required": [
              "restored",
              "safety"
            ],
            "properties": {
              "restored": {
                "type": "object",
                "required": [
                  "id",
                  "profile_id",
                  "reason",
                  "file_name",
                  "size_bytes",
                  "engine_build",
                  "created_at",
                  "exists"
                ],
                "properties": {
                  "id": {
                    "type": "string"
                  },
                  "profile_id": {
                    "type": "string"
                  },
                  "reason": {
                    "type": "string"
                  },
                  "file_name": {
                    "type": "string"
                  },
                  "size_bytes": {
                    "type": "integer"
                  },
                  "engine_build": {
                    "type": "string"
                  },
                  "created_at": {
                    "type": "integer"
                  },
                  "exists": {
                    "type": "boolean"
                  }
                }
              },
              "safety": {
                "type": "object",
                "required": [
                  "id",
                  "profile_id",
                  "reason",
                  "file_name",
                  "size_bytes",
                  "engine_build",
                  "created_at",
                  "exists"
                ],
                "properties": {
                  "id": {
                    "type": "string"
                  },
                  "profile_id": {
                    "type": "string"
                  },
                  "reason": {
                    "type": "string"
                  },
                  "file_name": {
                    "type": "string"
                  },
                  "size_bytes": {
                    "type": "integer"
                  },
                  "engine_build": {
                    "type": "string"
                  },
                  "created_at": {
                    "type": "integer"
                  },
                  "exists": {
                    "type": "boolean"
                  }
                }
              }
            }
          }
        }
      }
    },
    "default": {
      "description": "HTTP error envelope. The status and error.code identify the failure.",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/Error"
          }
        }
      }
    }
  }
}