> ## Documentation Index
> Fetch the complete documentation index at: https://docs.rootkey.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# Restore a deleted vault

> Brings a deleted vault back, with the files its delete took with it. A file that was deleted on its own before the vault stays in the trash. Files the retention policy already removed for good are named in `skippedPurgedIds`. With a personal access token the restore is made as the user and the activity names the user and the agent. It needs the `rootkey.delete` scope (a write scope is not enough), an organization role that may restore vaults, a team that owns the vault (an owner or an administrator of the organization needs none) and an organization that lets agents write. A RESTRICTED vault is never restored by an agent, whoever asks: a person does it in the ROOTKey app, with a second factor. A restore never needs a person's approval.



## OpenAPI

````yaml patch /vaults/{vaultAddress}/restore
openapi: 3.0.3
info:
  title: ROOTKey Documentation
  description: >-
    Your API of choice for creating, managing, and validating information easily
    and securely!
  termsOfService: https://www.rootkey.ai/legal/privacy-policy
  contact:
    name: ROOTKey
    url: https://www.rootkey.ai/contact
    email: support@rootkey.ai
  version: 1.0.0
servers:
  - description: Production
    url: https://api.rootkey.ai/api-v1/
security:
  - x-api-key: []
  - personalAccessToken: []
tags:
  - name: api-v1-public
    description: Unauthenticated top-level /api-v1 endpoints (health, plans, annual report)
  - name: api-v1-files
    description: >-
      File anchoring, versioning, validation and compliance reporting
      (/api-v1/platform/files)
  - name: api-v1-records
    description: Structured-data record anchoring (/api-v1/platform/records)
  - name: api-v1-vaults
    description: >-
      Vault lifecycle: create / update / delete / restore
      (/api-v1/platform/vaults, /api-v1/vaults)
  - name: api-v1-recovery-points
    description: >-
      Backup archives created from vault contents
      (/api-v1/platform/recovery-point)
  - name: api-v1-organizations
    description: >-
      The identity of a personal access token and the organizations it can act
      in (/api-v1/me, /api-v1/organizations, /api-v1/organization)
  - name: api-v1-agents
    description: >-
      What an agent asks the person it acts for: access to RESTRICTED data for a
      short time (/api-v1/agent-step-ups)
paths:
  /vaults/{vaultAddress}/restore:
    patch:
      tags:
        - api-v1-vaults
      summary: Restore a deleted vault
      description: >-
        Brings a deleted vault back, with the files its delete took with it. A
        file that was deleted on its own before the vault stays in the trash.
        Files the retention policy already removed for good are named in
        `skippedPurgedIds`. With a personal access token the restore is made as
        the user and the activity names the user and the agent. It needs the
        `rootkey.delete` scope (a write scope is not enough), an organization
        role that may restore vaults, a team that owns the vault (an owner or an
        administrator of the organization needs none) and an organization that
        lets agents write. A RESTRICTED vault is never restored by an agent,
        whoever asks: a person does it in the ROOTKey app, with a second factor.
        A restore never needs a person's approval.
      parameters:
        - $ref: '#/components/parameters/OrganizationHeader'
        - $ref: '#/components/parameters/TestModeHeader'
        - name: vaultAddress
          in: path
          required: true
          schema:
            type: string
      responses:
        '200':
          description: Vault restored
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RestoreResponse'
        '400':
          description: >-
            The vault is not deleted (`wallet_not_deleted`), the retention
            deadline passed (`retention_deadline_expired`), the address is not
            valid (`invalid_wallet_address`), or the plan has no room for it
            (`usage_limit_exceeded`).
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DomainErrorResponse'
        '401':
          description: >-
            Unauthenticated. A missing, malformed, unknown, inactive, revoked or
            expired credential all get the same answer.
        '403':
          $ref: '#/components/responses/AgentAccessDenied'
        '404':
          description: No such vault in the organization (`resource_not_found`).
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DomainErrorResponse'
        '410':
          description: >-
            The retention policy already removed the vault for good
            (`wallet_already_purged`).
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DomainErrorResponse'
        '429':
          description: >-
            Too many requests for the Restore Center. The `Retry-After` header
            says how many seconds to wait. See [Rate
            Limits](/pages/rate-limits).
        '500':
          $ref: '#/components/responses/InternalError'
      security:
        - x-api-key: []
        - personalAccessToken: []
components:
  parameters:
    OrganizationHeader:
      name: X-RootKey-Organization
      in: header
      required: false
      schema:
        type: string
      description: >-
        The organization a personal access token acts in: the `id` of one of the
        organizations that `GET /organizations` lists. Required with a personal
        access token on every endpoint that works inside an organization;
        without it the request gets `organization_header_required`. Ignored with
        an API key, which belongs to exactly one organization.
    TestModeHeader:
      name: x-test-mode
      in: header
      required: false
      schema:
        type: string
        enum:
          - 'true'
          - 'false'
        default: 'false'
      description: >-
        Whether a personal access token works on live data (`false`, the
        default) or on test data (`true`). Only this header decides, never a
        query string or a body field. An API key is itself a test or a live key
        and works on that data.
  schemas:
    RestoreResponse:
      type: object
      required:
        - skippedPurgedIds
      properties:
        skippedPurgedIds:
          type: array
          items:
            type: string
          description: >-
            What could not come back because the retention policy had already
            removed it for good.
    DomainErrorResponse:
      type: object
      properties:
        error:
          type: object
          properties:
            requestId:
              type: string
            message:
              type: string
            errorCode:
              type: string
            docUrl:
              type: string
            timestamp:
              type: string
              format: date-time
  responses:
    AgentAccessDenied:
      description: >-
        Forbidden. With a personal access token or an app connected through the
        hosted connector, the organization, the user or the token does not allow
        the request, and the `errorCode` says which: `agent_org_not_allowed`,
        `agent_user_blocked`, `agent_two_factor_required`,
        `agent_access_disabled`, `agent_write_not_allowed`,
        `agent_personal_tokens_disabled`, `agent_client_not_allowed`,
        `insufficient_scope`, `insufficient_permission`,
        `agent_restricted_data_denied`, `agent_step_up_required` or
        `email_verification_required`. A user who is not a member of the
        organization, or a network an IP access rule blocks, gets
        `access_policy_denied`. Each code has an entry on the
        [Errors](/api-reference/errors) page.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/DomainErrorResponse'
    InternalError:
      description: Internal server error
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/DomainErrorResponse'
  securitySchemes:
    x-api-key:
      type: apiKey
      name: x-api-key
      in: header
      description: >-
        ROOTKey API key. A test key works on your organization's test data and a
        live key on its live data; both are used with the same API.
    personalAccessToken:
      type: http
      scheme: bearer
      bearerFormat: rk_pat_...
      description: >-
        Personal access token of a ROOTKey user, sent as `Authorization: Bearer
        rk_pat_...`. A token acts as the user who created it, in the
        organization named by the `X-RootKey-Organization` header, and never
        with more access than that user has in the ROOTKey app: the
        organization's agent policy, the user's own role and teams, and the
        token's scopes (`rootkey.read`, `rootkey.write`, `rootkey.delete`) all
        apply. A missing, malformed, unknown, revoked or expired token gets the
        same `401`. Send either an `x-api-key` or a bearer token, never both: a
        request with both gets `conflicting_credentials`. See
        [Authentication](/api-reference/auth).

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.