Acronis Vaults API

openapi: 3.2.0
info:
  title: Vault Manager Vaults API
  version: v1
servers:
- url: https://dev-cloud.acronis.com/api/vault_manager/v1
  variables: {}
tags:
- name: Vaults
paths:
  /vaults:
    get:
      operationId: Fetch vaults
      description: Fetches a list of vaults.
      x-ExtJS: VaultManager.ListVaults
      parameters:
      - name: id
        description: IDs of vaults to fetch. Multiple values can be specified by repeating the query parameter.
        required: false
        in: query
        schema:
          description: IDs of vaults to fetch. Multiple values can be specified by repeating the query parameter.
          type: array
          items:
            $ref: '#/components/schemas/uuid'
      - name: storageNodeId
        description: ID of Storage node to search vaults for.
        required: false
        in: query
        schema:
          description: ID of Storage node to search vaults for.
          type: string
          format: uuid
      - name: managed
        description: 'Show only managed or unmanaged vaults.


          If not specified, all types of vaults are listed.

          '
        required: false
        in: query
        schema:
          description: 'Show only managed or unmanaged vaults.


            If not specified, all types of vaults are listed.

            '
          type: boolean
      - name: name
        description: Filter vaults by name. Supports matching any number of characters using asterisk wildcard character.
        required: false
        in: query
        schema:
          description: Filter vaults by name. Supports matching any number of characters using asterisk wildcard character.
          type: string
      - name: hostname
        description: Filter vaults by hostname. Supports matching any number of characters using asterisk wildcard character.
        required: true
        in: query
        schema:
          description: Filter vaults by hostname. Supports matching any number of characters using asterisk wildcard character.
          type: string
      - name: resourceId
        description: Show only vaults which contains archives of specified resource ID.
        required: false
        in: query
        schema:
          description: Show only vaults which contains archives of specified resource ID.
          type: string
          format: uuid
      - name: uri
        description: Filter vaults by URI. Supports matching any number of characters using asterisk wildcard character.
        required: false
        in: query
        schema:
          description: Filter vaults by URI. Supports matching any number of characters using asterisk wildcard character.
          type: string
      - name: type
        description: Show only vaults of specified storage types.
        required: false
        in: query
        schema:
          description: Show only vaults of specified storage types.
          type: array
          items:
            $ref: '#/components/schemas/storage_type'
      - name: storageId
        description: Show only vaults in the storage with specified ID.
        required: false
        in: query
        schema:
          description: Show only vaults in the storage with specified ID.
          type: string
          format: uuid
      - name: connectionID
        description: Show only vaults linked to Cloud Connection with specified Connection ID.
        required: false
        in: query
        schema:
          description: Show only vaults linked to Cloud Connection with specified Connection ID.
          type: string
      - name: accessibleForAgent
        description: "Show only vaults that satisfy one of following conditions:\n\n1.  The vault is local to the specified agent (its `storage_type` is\n    `local_folder`, `cd`, `tape`, `asz` or `removable_drive` AND `managing_agent_id=accessibleForAgent`).\n1.  The vault is not local to any agent (for `storage_type` that are not listed in first condition).\n"
        required: false
        in: query
        schema:
          description: "Show only vaults that satisfy one of following conditions:\n\n1.  The vault is local to the specified agent (its `storage_type` is\n    `local_folder`, `cd`, `tape`, `asz` or `removable_drive` AND `managing_agent_id=accessibleForAgent`).\n1.  The vault is not local to any agent (for `storage_type` that are not listed in first condition).\n"
          type: string
      - name: tenantId
        description: Show only vaults in specific Tenant ID (do not include its subtenants).
        required: false
        in: query
        schema:
          description: Show only vaults in specific Tenant ID (do not include its subtenants).
          oneOf:
          - $ref: '#/components/schemas/id'
          - $ref: '#/components/schemas/item1'
      - name: query
        description: Show vaults that contain query string in the name or URI or hostname.
        required: false
        in: query
        schema:
          description: Show vaults that contain query string in the name or URI or hostname.
          type: string
      - name: includeStats
        description: Calculate and include vault stats.
        required: false
        in: query
        schema:
          description: Calculate and include vault stats.
          type: boolean
      - name: includeStorageStats
        description: 'Include storage-side stats about vault calculated at DC and return them in the `immutable_size` field.


          If false or not specified, the `immutable_size` field will not be included in the response data.

          '
        required: false
        in: query
        schema:
          description: 'Include storage-side stats about vault calculated at DC and return them in the `immutable_size` field.


            If false or not specified, the `immutable_size` field will not be included in the response data.

            '
          type: boolean
      - name: includeLastBackupTime
        description: Calculate and include vault's last backup time.
        required: false
        in: query
        schema:
          description: Calculate and include vault's last backup time.
          type: boolean
      - name: includeActions
        description: Calculate and include possible actions in the response.
        required: false
        in: query
        schema:
          description: Calculate and include possible actions in the response.
          type: boolean
      - name: includeDeleted
        description: Whether to include vaults marked as deleted.
        required: false
        in: query
        schema:
          description: Whether to include vaults marked as deleted.
          type: boolean
      - name: before
        description: 'Base64-encoded token obtained from the previous response.

          Points to the end of the page.

          '
        in: query
        schema:
          description: 'Base64-encoded token obtained from the previous response.

            Points to the end of the page.

            '
          type: string
      - name: after
        description: 'Base64-encoded token obtained from the previous response.

          Points to the start of the page.

          '
        in: query
        schema:
          description: 'Base64-encoded token obtained from the previous response.

            Points to the start of the page.

            '
          type: string
      - name: offset
        description: The number of elements to skip before beginning to return elements.
        in: query
        schema:
          description: The number of elements to skip before beginning to return elements.
          default: 0
          type: integer
      - name: limit
        description: Limit the number of elements to return in one page.
        in: query
        schema:
          description: Limit the number of elements to return in one page.
          default: 100
          type: integer
          maximum: 1000
      - name: count
        description: Show total count in the response.
        in: query
        schema:
          description: Show total count in the response.
          default: false
          type: boolean
      - name: order
        description: 'An ordering filter that orders the results by value of the specified properties.

          Property in inner object can be specified using dot, e.g. orphanage.status.


          Available operators:


          * `asc` - ascending

          * `desc` - descending

          '
        required: false
        in: query
        schema:
          description: 'An ordering filter that orders the results by value of the specified properties.

            Property in inner object can be specified using dot, e.g. orphanage.status.


            Available operators:


            * `asc` - ascending

            * `desc` - descending

            '
          type: string
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/vault_info_page'
      security:
      - oauth2:
        - vault_manager::system_admin
        - vault_manager::admin
        - vault_manager::read
        - protection::readonly
      tags:
      - Vaults
      summary: Fetch vaults
      x-summary-source: derived
    post:
      operationId: Create or attach vault
      description: 'Creates or attaches a vault.


        Issues corresponding commands to agents. If commands are completed successfully,

        Vault Manager will store the new vault record.'
      x-ExtJS: VaultManager.CreateVault
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/vault_create_request'
      responses:
        '201':
          description: ''
          content:
            application/json:
              schema:
                description: Acronis Storage Node response for task completion.
                type: object
                additionalProperties: false
                properties:
                  id:
                    description: Universally unique identifier.
                    type: string
                    format: uuid
                  completionResult:
                    description: Result of the task executed on Acronis Storage Node.
                    type: string
      security:
      - oauth2:
        - vault_manager::system_admin
        - vault_manager::admin
      tags:
      - Vaults
      summary: Create or attach vault
      x-summary-source: derived
  /vaults/refresh:
    post:
      operationId: Refresh vaults
      description: Sets an agent task to refresh vaults.
      x-ExtJS: VaultManager.VaultRefresh
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/vault_refresh_task'
      responses:
        '200':
          description: List of task IDs created.
          content:
            application/json:
              schema:
                type: object
                additionalProperties: false
                properties:
                  items:
                    description: List of Tasks identifiers.
                    type: array
                    items:
                      type: string
        '400':
          description: Invalid request.
          content: {}
        '500':
          description: Internal error occurred.
          content: {}
      security:
      - oauth2:
        - vault_manager::system_admin
        - vault_manager::admin
        - protection::readonly
      tags:
      - Vaults
      summary: Refresh vaults
      x-summary-source: derived
  /vaults/{vaultID}:
    get:
      operationId: Fetch vault
      description: Fetches a vault.
      x-ExtJS: VaultManager.GetVault
      parameters:
      - name: includeStats
        description: Calculate and include vault stats.
        required: false
        in: query
        schema:
          description: Calculate and include vault stats.
          type: boolean
      - name: includeStorageStats
        description: 'Include storage-side stats about vault calculated at DC and return them in the `immutable_size` field.


          If false or not specified, the `immutable_size` field will not be included in the response data.

          '
        required: false
        in: query
        schema:
          description: 'Include storage-side stats about vault calculated at DC and return them in the `immutable_size` field.


            If false or not specified, the `immutable_size` field will not be included in the response data.

            '
          type: boolean
      - name: includeLastBackupTime
        description: Calculate and include vault last backup time.
        required: false
        in: query
        schema:
          description: Calculate and include vault last backup time.
          type: boolean
      - name: includeActions
        description: Calculate and include possible actions in the response.
        required: false
        in: query
        schema:
          description: Calculate and include possible actions in the response.
          type: boolean
      - name: vaultID
        required: true
        in: path
        schema:
          $ref: '#/components/schemas/uuid'
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/vault_full_info'
        '400':
          description: Invalid request.
          content: {}
        '404':
          description: Resource not found.
          content: {}
        '500':
          description: Internal error occurred.
          content: {}
      security:
      - oauth2:
        - vault_manager::system_admin
        - vault_manager::admin
        - vault_manager::read
        - protection::readonly
      tags:
      - Vaults
      summary: Fetch vault
      x-summary-source: derived
    delete:
      operationId: Delete vault
      description: Unregisters, deletes or detaches a vault.
      x-ExtJS: VaultManager.DeleteVault
      parameters:
      - name: tenantID
        description: Tenant ID (where the vault will be removed from) to separate the target tenant from the effective one
        required: false
        in: query
        schema:
          description: Tenant ID (where the vault will be removed from) to separate the target tenant from the effective one
          oneOf:
          - $ref: '#/components/schemas/id'
          - $ref: '#/components/schemas/item1'
      - name: vaultID
        required: true
        in: path
        schema:
          $ref: '#/components/schemas/uuid'
      responses:
        '204':
          description: The vault was deleted successfully.
          content: {}
        '400':
          description: Invalid request.
          content: {}
        '404':
          description: The vault is not found.
          content: {}
        '409':
          description: Vault update has failed because its last seen time is in the past.
          content: {}
        '500':
          description: Any other error.
          content: {}
      security:
      - oauth2:
        - vault_manager::system_admin
        - vault_manager::admin
      tags:
      - Vaults
      summary: Delete vault
      x-summary-source: derived
  /vaults/{vaultID}/archives:
    get:
      operationId: Fetch vault archives
      description: Fetches a list of vault archives.
      x-ExtJS: VaultManager.ListVaultArchives
      parameters:
      - name: includeOrphanage
        description: 'Include orphanage status of archive.


          If false or not specified, the `orphanage` object will not be included in the response data.

          '
        required: false
        in: query
        schema:
          description: 'Include orphanage status of archive.


            If false or not specified, the `orphanage` object will not be included in the response data.

            '
          default: false
          type: boolean
      - name: centralizedPlanId
        description: Show only archives created by centralized plan with specified ID.
        required: false
        in: query
        schema:
          description: Show only archives created by centralized plan with specified ID.
          type: string
          format: uuid
      - name: resourceId
        description: Show only archives that contain backups for at least one resource from the specified list.
        required: false
        in: query
        schema:
          description: Show only archives that contain backups for at least one resource from the specified list.
          type: array
          items:
            description: Universally unique identifier.
            type: string
            format: uuid
      - name: format
        description: Show a list of Archives of specified formats.
        required: false
        in: query
        schema:
          description: Show a list of Archives of specified formats.
          type: array
          items:
            $ref: '#/components/schemas/items_5'
      - name: name
        description: Show a list of archives of specified archive name. Supports matching any number of characters using asterisk wildcard character if it's enabled with the `wildcard` query string parameter.
        required: false
        in: query
        schema:
          description: Show a list of archives of specified archive name. Supports matching any number of characters using asterisk wildcard character if it's enabled with the `wildcard` query string parameter.
          type: string
      - name: count
        description: Show total count in the response.
        in: query
        schema:
          description: Show total count in the response.
          default: false
          type: boolean
      - name: agentId
        description: Show a list of archives of specified agent ID.
        required: false
        in: query
        schema:
          description: Show a list of archives of specified agent ID.
          type: string
          format: uuid
      - name: wildcard
        description: Enable wildcard support in the name filter.
        required: false
        in: query
        schema:
          description: Enable wildcard support in the name filter.
          default: false
          type: boolean
      - name: before
        description: 'Base64-encoded token obtained from the previous response.

          Points to the end of the page.

          '
        in: query
        schema:
          description: 'Base64-encoded token obtained from the previous response.

            Points to the end of the page.

            '
          type: string
      - name: forensic
        description: 'Show only archives with forensic data or without forensic.


          If not specified, archives are listed regardless of forensic data.

          '
        required: false
        in: query
        schema:
          description: 'Show only archives with forensic data or without forensic.


            If not specified, archives are listed regardless of forensic data.

            '
          type: boolean
      - name: storageType
        description: Show a list of Archives in vaults of specified storage types.
        required: false
        in: query
        schema:
          description: Show a list of Archives in vaults of specified storage types.
          type: array
          items:
            $ref: '#/components/schemas/storage_type'
      - name: orphanage.status
        description: 'Filter archives by orphanage status.


          * NONE - Not orphaned

          * NO_POLICY - Orphaned due to missing policy

          * NO_RESOURCE - Orphaned due to missing resource

          If not specified, archives are listed regardless of their orphanage status.

          '
        required: false
        in: query
        schema:
          description: 'Filter archives by orphanage status.


            * NONE - Not orphaned

            * NO_POLICY - Orphaned due to missing policy

            * NO_RESOURCE - Orphaned due to missing resource

            If not specified, archives are listed regardless of their orphanage status.

            '
          type: array
          items:
            enum:
            - NONE
            - NO_POLICY
            - NO_RESOURCE
            type: string
      - name: includeStats
        description: 'Include additional information about archive.


          If false or not specified, the `stats` field will not be included in the response data.

          '
        required: false
        in: query
        schema:
          description: 'Include additional information about archive.


            If false or not specified, the `stats` field will not be included in the response data.

            '
          default: false
          type: boolean
      - name: includePrePatchManagement
        description: 'Include pre-patch management status of archive.


          If false or not specified, the `pre_patch_management` field will not be included in the response data.

          '
        required: false
        in: query
        schema:
          description: 'Include pre-patch management status of archive.


            If false or not specified, the `pre_patch_management` field will not be included in the response data.

            '
          default: false
          type: boolean
      - name: showDeleted
        description: 'A flag that specifies what should be added to the list of returned archives:


          * 1 - All deleted archives are added to the list of archives.

          * 2 - Only deleted archives marked as immutable are added to the list of archives.

          * 3 - Only deleted archives are included to the list of archives, other ones are excluded.

          * 0 - No deleted archives are added to the list of archives.

          '
        required: false
        in: query
        schema:
          description: 'A flag that specifies what should be added to the list of returned archives:


            * 1 - All deleted archives are added to the list of archives.

            * 2 - Only deleted archives marked as immutable are added to the list of archives.

            * 3 - Only deleted archives are included to the list of archives, other ones are excluded.

            * 0 - No deleted archives are added to the list of archives.

            '
          enum:
          - 0
          - 1
          - 2
          - 3
          type: integer
      - name: targetAgentId
        description: Select target agent to calculate actions.
        required: false
        in: query
        schema:
          description: Select target agent to calculate actions.
          type: string
          format: uuid
      - name: malwareFound
        description: 'Show only archives with backups that have the specified malware status.


          Possible malware statuses:


          * notScanned - No backups were scanned in the archive.

          * clean - Backups that don''t contain malware.

          * malware - Backup that contain malware.

          '
        required: false
        in: query
        schema:
          description: 'Show only archives with backups that have the specified malware status.


            Possible malware statuses:


            * notScanned - No backups were scanned in the archive.

            * clean - Backups that don''t contain malware.

            * malware - Backup that contain malware.

            '
          type: array
          items:
            enum:
            - notScanned
            - clean
            - malware
            type: string
      - name: offset
        description: The number of elements to skip before beginning to return elements.
        in: query
        schema:
          description: The number of elements to skip before beginning to return elements.
          default: 0
          type: integer
      - name: includeStorageStats
        description: 'Include storage-side stats about archive calculated at DC and return them in the `immutable_size` field.


          If false or not specified, the `immutable_size` field will not be included in the response data.

          '
        required: false
        in: query
        schema:
          description: 'Include storage-side stats about archive calculated at DC and return them in the `immutable_size` field.


            If false or not specified, the `immutable_size` field will not be included in the response data.

            '
          default: false
          type: boolean
      - name: after
        description: 'Base64-encoded token obtained from the previous response.

          Points to the start of the page.

          '
        in: query
        schema:
          description: 'Base64-encoded token obtained from the previous response.

            Points to the start of the page.

            '
          type: string
      - name: order
        description: 'An ordering filter that orders the results by value of the specified properties.

          Property in inner object can be specified using dot, e.g. orphanage.status.


          Available operators:


          * `asc` - ascending

          * `desc` - descending

          '
        required: false
        in: query
        schema:
          description: 'An ordering filter that orders the results by value of the specified properties.

            Property in inner object can be specified using dot, e.g. orphanage.status.


            Available operators:


            * `asc` - ascending

            * `desc` - descending

            '
          type: string
      - name: includeActions
        description: Calculate and include possible actions in the response.
        required: false
        in: query
        schema:
          description: Calculate and include possible actions in the response.
          type: boolean
      - name: fromDate
        description: Filters archives by the last updated date and time that is greater or equal to the given date and time.
        required: false
        in: query
        schema:
          description: Filters archives by the last updated date and time that is greater or equal to the given date and time.
          type: string
          format: date-time
      - name: backupPlanId
        description: Show only archives created by backup plan with specified ID.
        required: false
        in: query
        schema:
          description: Show only archives created by backup plan with specified ID.
          type: string
          format: uuid
      - name: includeMalwareFound
        description: 'Include malware assessment result of backups in the archive.


          If false or not specified, the `malware_found` field will not be included in the response data.

          '
        required: false
        in: query
        schema:
          description: 'Include malware assessment result of backups in the archive.


            If false or not specified, the `malware_found` field will not be included in the response data.

            '
          default: false
          type: boolean
      - name: toDate
        description: Filters archives by the last updated date and time that is less than or equal to the given date and time.
        required: false
        in: query
        schema:
          description: Filters archives by the last updated date and time that is less than or equal to the given date and time.
          type: string
          format: date-time
      - name: type
        description: Show a list of Archives of specified types.
        required: false
        in: query
        schema:
          description: Show a list of Archives of specified types.
          type: array
          items:
            $ref: '#/components/schemas/items_4'
      - name: limit
        description: Limit the number of elements to return in one page.
        in: query
        schema:
          description: Limit the number of elements to return in one page.
          default: 100
          type: integer
          maximum: 1000
      - name: archiveId
        description: Show a list of archives of specified archive IDs.
        required: false
        in: query
        schema:
          description: Show a list of archives of specified archive IDs.
          type: array
          items:
            description: Universally unique identifier.
            type: string
            format: uuid
      - name: includeCatalogInfo
        description: 'Include cataloged status of archive.


          If false or not specified, `cataloged_status` and `actions` fields will not

          be included in the response data.

          '
        required: false
        in: query
        schema:
          description: 'Include cataloged status of archive.


            If false or not specified, `cataloged_status` and `actions` fields will not

            be included in the response data.

            '
          default: false
          type: boolean
      - name: prePatchManagementOnly
        description: 'Show only archives with at least one backup which was made before patch management.


          If false or not specified, archives are listed regardless of this filter.

          '
        required: false
        in: query
        schema:
          description: 'Show only archives with at least one backup which was made before patch management.


            If false or not specified, archives are listed regardless of this filter.

            '
          default: false
          type: boolean
      - name: vaultID
        required: true
        in: path
        schema:
          $ref: '#/components/schemas/uuid'
      responses:
        '200':
          description: The request was successful.
          content:
            application/json:
              schema:
                example:
                  items:
                  - id: 1f8867c2-179f-ef34-159f-84279a18174d
                    name: WIN-FBM117GB12I-BACDFE64-B958-4F32-B204-2043249DBB2B-EDD63875-4641-44AA-B1A6-BACB4610AA11A
                    vault_id: 885b7fe4-95ce-71fd-fff5-8de5b3cce9bb
                    attributes:
                      Description: ''
                      MachineName: WIN-FBM117GB12I
                      MarkedForDeletion: '0'
                      MediaIDs: ''
                      OwnerID: S-1-5-18
                      OwnerName: WORKGROUP\WIN-FBM117GB12I$
                      archive3format: '1'
                      display-name: 'WIN-FBM117GB12I - Files/folders to WIN-FBM117GB12I: C:\local\'
                      plan-id: FF26E847-4310-0B94-2E31-375BA31C16EE
                      plan-name: 'Files/folders to WIN-FBM117GB12I: C:\local\'
                      resource-name: WIN-FBM117GB12I
                    size: 70893568
                    type: file
                    format: '11'
                    created: '2018-02-02T01:39:24Z'
                    updated: '2018-02-02T01:39:24Z'
                    last_backup_created: '2018-02-02T01:40:05Z'
                    resource_type: file
                    protected_by_password: false
                    encryption_algorithm: none
                    deleted: false
                    file_name: ''
                    tenant_id: 00000000-0000-0000-0000-000000000000
                    tenant_locator: /00000000-0000-0000-0000-000000000000/
                    agent_id: 45eb1623-fa48-44a6-9c35-17188781adc5
                    source_key: ''
                    source_usn: 0
                    actions:
                    - refresh
                    cataloged_status: notIndexed
                    stats:
                      first_backup: '2018-01-01T12:10:00Z'
                      last_backup_size: 140
                      last_backup_path: test-slice-stream-name
                      backup_count: 5
                    search_index_size: 0
                  paging:
                    cursors:
                      before: eyJfdXJsUGF0aCI6WyIvYXBpL3ZhdWx0X21hbmFnZXIvdjEvYXJjaGl2ZXMiXSwib2Zmc2V0IjpbIjAiXX0
                type: object
                additionalProperties: false
                properties:
                  paging:
                    title: Paging status
                    description: Paging status.
                    type: object
                    additionalProperties: false
                    properties:
                      total_count:
                        description: Total number of selected items according given filters.
                        type: integer
                      cursors:
             

# --- truncated at 32 KB (199 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/acronis/refs/heads/main/openapi/acronis-vaults-api-openapi.yml