Acronis Sync API

openapi: 3.2.0
info:
  title: Vault Manager Sync API
  version: v1
servers:
- url: https://dev-cloud.acronis.com/api/vault_manager/v1
  variables: {}
tags:
- name: Sync
paths:
  /sync/archives:
    get:
      operationId: Fetch archives sync info
      description: Fetches the archives sync information.
      x-ExtJS: VaultManager.ListArchivesSyncInfo
      parameters:
      - name: agentId
        description: Filter archives by agent ID.
        required: false
        in: query
        schema:
          description: Filter archives by agent ID.
          type: string
          format: uuid
      - name: sourceUsnGt
        description: Show only archives with source Update Sequence Number (USN) greater than requested.
        required: false
        in: query
        schema:
          description: Show only archives with source Update Sequence Number (USN) greater than requested.
          type: integer
      - name: limit
        required: true
        in: query
        schema:
          type: integer
      - 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:
                description: Archive sync info list.
                type: array
                items:
                  type: object
                  additionalProperties: false
                  properties:
                    source_key:
                      type: string
                    source_usn:
                      type: integer
      security:
      - oauth2:
        - vault_manager::system_admin
        - vault_manager::admin
        - vault_manager::read
        - protection::readonly
      tags:
      - Sync
      summary: Fetch archives sync info
      x-summary-source: derived
    post:
      operationId: Update archives batch
      description: Updates a batch of archives.
      x-ExtJS: VaultManager.UpdateArchivesBulk
      requestBody:
        content:
          application/json:
            schema:
              description: Request to update archives set.
              type: object
              additionalProperties: false
              properties:
                vault:
                  description: Properties with the request-wide effect when `full_resync` or `last_batch` is true. Ignored otherwise.
                  type: object
                  properties:
                    id:
                      $ref: '#/components/schemas/id_12'
                    last_seen_at:
                      description: Allows to update `last_seen_at` value in archive and backup objects that are deleted by this request. `last_seen_at` is updated if this property is not null both in the request and in the existing archive object and the request contains more recent `last_seen_at` than the value in the archive object.
                      type: string
                      format: date-time
                add:
                  description: List of archives that should be created.
                  type: array
                  items:
                    allOf:
                    - title: Archive
                      description: Archive description.
                      type: object
                      additionalProperties: false
                      required:
                      - id
                      - name
                      - vault_id
                      - format
                      - created
                      - file_name
                      properties:
                        id:
                          $ref: '#/components/schemas/id_12'
                        name:
                          description: Name of the archive.
                          type: string
                        vault_id:
                          $ref: '#/components/schemas/id_12'
                        legacy_id:
                          description: ID that is needed for old WCS API support. Don't use it in new services!
                          type: string
                        attributes:
                          description: Any archive-specific attributes.
                          type: object
                        size:
                          description: Size of the archive in bytes.
                          type: integer
                        compressed_data_size:
                          description: Sum of compressed data in all slices in bytes. May be larger than `data_size` in case of dedup. Calculated by archive implementation.
                          type: integer
                        data_size:
                          description: Size of backed up data in all slices of archive in bytes. Calculated by archive implementation.
                          type: integer
                        original_data_size:
                          description: Size of the data that can be restored from all slices of the archive in bytes. Calculated by archive implementation.
                          type: integer
                        type:
                          description: Archive type.
                          enum:
                          - unknown
                          - file
                          - image
                          - vss_application
                          - msexchange
                          - msexchange_doc
                          - mssql
                          - oracle
                          - ad
                          - empty
                          type: string
                        format:
                          description: Format of archive.
                          enum:
                          - '11'
                          - '12'
                          - alwaysIncremental
                          type: string
                        created:
                          description: Date and time in RFC 3339 format the archive was created.
                          type: string
                          format: date-time
                        updated:
                          description: Date and time in RFC 3339 format the archive was updated.
                          type: string
                          format: date-time
                        last_backup_created:
                          description: Date and time in RFC 3339 format the last slice was created.
                          type: string
                          format: date-time
                        resource_type:
                          description: 'Type of resource stored in archive (e.g., `machine`, `mssql_server`). Can include additional resource type (e.g., type of VM: `datastore.vmwesx`, `virtual_appliance.mshyperv`).'
                          type: string
                        protected_by_password:
                          description: If true, the archive is protected by password. False otherwise.
                          type: boolean
                        encryption_algorithm:
                          description: Encryption algorithm of the archive.
                          enum:
                          - none
                          - aes_128
                          - aes128
                          - aes_192
                          - aes192
                          - aes_256
                          - aes256
                          - gost
                          type: string
                        deleted:
                          description: If true, the archive is deleted and no longer exists. False otherwise.
                          type: boolean
                        file_name:
                          description: The archive file name.
                          type: string
                        tenant_id:
                          description: Tenant identifier. Uses numeric identifier in cloud and UUID in on-premises.
                          oneOf:
                          - $ref: '#/components/schemas/id_12'
                          - description: Numeric identifier.
                            type: string
                            pattern: ^\d+$
                        tenant_locator:
                          description: Locator of the tenant that owns the archive.
                          type: string
                        agent_id:
                          $ref: '#/components/schemas/id_12'
                        source_key:
                          description: Key of archive in DML DB. Used for legacy agents support.
                          type: string
                        source_usn:
                          description: Timestamp of archive in DML DB. Used for legacy agents support.
                          type: integer
                        actions:
                          description: List of available actions.
                          type: array
                          items:
                            type: string
                        agent_name:
                          description: Hostname of agent machine.
                          type: string
                          format: hostname
                        centralized_plan_id:
                          description: Global identifier of the backup plan in accordance to that the archive is created.
                          type: string
                        backup_plan_id:
                          description: ID of the backup plan that created the archive.
                          type: string
                        backup_plan_name:
                          description: Name of the backup plan that created the archive.
                          type: string
                        description:
                          description: User-defined description.
                          type: string
                        display_name:
                          description: Human-readable archive name.
                          type: string
                        owner_id:
                          description: ID of the user (SID for Windows) that owns the archive.
                          type: string
                        owner_name:
                          description: Name of the user that owns the archive.
                          type: string
                        resource_id:
                          description: ID of the resource that stored in the archive.
                          type: string
                        resource_ids:
                          description: List of identifiers of backed up resources.
                          type: array
                          items:
                            description: ID of backed up resource.
                            type: string
                        resource_name:
                          description: Name of the resource that stored in the archive.
                          type: string
                        consistent:
                          description: False if archive content could be outdated and a refresh is required. True otherwise.
                          type: boolean
                        stats:
                          title: Archive stats
                          description: Additional information about slices.
                          type: object
                          additionalProperties: false
                          properties:
                            first_backup:
                              type: string
                            last_backup_size:
                              type: integer
                            last_backup_path:
                              type: string
                            backup_count:
                              type: integer
                        marked_for_deletion:
                          description: True if archive marked as deleted. False otherwise.
                          type: boolean
                        pds_status:
                          description: State of physical data shipment.
                          enum:
                          - archiveNotReady
                          - archiveInTransit
                          - archiveDelivered
                          type: string
                        search_index_size:
                          description: Size of search index.
                          type: integer
                        resource_path:
                          description: Path to the backed up resource in a format acceptable by Resource Manager.
                          type: string
                        last_seen_at:
                          description: Last time when the archive was seen.
                          type: string
                          format: date-time
                        cataloged_status:
                          description: State of archive is cataloged.
                          enum:
                          - notIndexed
                          - partiallyIndexed
                          - indexed
                          type: string
                        forensic:
                          description: True if the archive contains forensic data. False otherwise.
                          type: boolean
                        pre_patch_management:
                          description: Flag that specifies whether the archive contains at least one backup which was made before patch management. True if there's at least one backup that was made before patch management. False otherwise.
                          type: boolean
                        malware_found:
                          description: Malware assessment result of backups in the archive. Absent if no backups were scanned. True if at least one backup has malware. False otherwise.
                          type: boolean
                        logical_size:
                          description: Reflects logical size of archive.
                          type: integer
                        immutable_size:
                          description: Reflects immutable size of archive.
                          type: integer
                        deleted_immutable:
                          description: True if the archive is marked as deleted immutable. False otherwise.
                          type: boolean
                        orphanage:
                          title: Set archive orphanage status request
                          description: Archive orphanage status description.
                          type: object
                          required:
                          - status
                          properties:
                            status:
                              description: Value of archive orphanage status.
                              enum:
                              - NONE
                              - NO_POLICY
                              - NO_RESOURCE
                              type: string
                    - type: object
                      required:
                      - vault_id
                      - archive_id
                      properties:
                        vault_id: {}
                        archive_id: {}
                delete:
                  description: Specifies archives that should be deleted.
                  type: object
                  additionalProperties: false
                  properties:
                    change_tag:
                      description: User-defined tag of operation.
                      type: string
                    ids:
                      description: List of archives that should be deleted.
                      type: array
                      items:
                        $ref: '#/components/schemas/items_13'
                full_resync:
                  description: Specifies the full re-sync mode. If true, `add` array will be treated like a full and only full list of vault archives. Other archives will be marked as deletable and if not added again they will be deleted at the end of the session.
                  type: boolean
                last_batch:
                  description: Specifies that it is the last batch. If true, the session started with full_resync for the same vault will be closed, so non-added archives will be deleted.
                  type: boolean
      responses:
        '200':
          description: 'Multiple operations have taken over archives with successful status

            for each archive can be viewed in the body of the response.

            '
          content:
            application/json:
              schema:
                description: Archive batch update result.
                type: object
                additionalProperties: false
                properties:
                  created:
                    description: IDs of created archives.
                    type: array
                    items:
                      $ref: '#/components/schemas/items_13'
                  updated:
                    description: IDs of updated archives.
                    type: array
                    items:
                      $ref: '#/components/schemas/items_13'
                  errors:
                    description: List of errors per archive that encountered during batch operation execution.
                    type: array
                    items:
                      $ref: '#/components/schemas/error'
        '207':
          description: 'Multiple operations have taken over archives with different status

            for each archive can be viewed in the body of the response.

            '
          content:
            application/json:
              schema:
                description: Archive batch update result.
                type: object
                additionalProperties: false
                properties:
                  created:
                    description: IDs of created archives.
                    type: array
                    items:
                      $ref: '#/components/schemas/items_13'
                  updated:
                    description: IDs of updated archives.
                    type: array
                    items:
                      $ref: '#/components/schemas/items_13'
                  errors:
                    description: List of errors per archive that encountered during batch operation execution.
                    type: array
                    items:
                      $ref: '#/components/schemas/error'
        '404':
          description: The involved archives/vaults have not been found.
          content:
            application/json:
              schema:
                description: Archive batch update result.
                type: object
                additionalProperties: false
                properties:
                  created:
                    description: IDs of created archives.
                    type: array
                    items:
                      $ref: '#/components/schemas/items_13'
                  updated:
                    description: IDs of updated archives.
                    type: array
                    items:
                      $ref: '#/components/schemas/items_13'
                  errors:
                    description: List of errors per archive that encountered during batch operation execution.
                    type: array
                    items:
                      $ref: '#/components/schemas/error'
      security:
      - oauth2:
        - vault_manager::system_admin
        - vault_manager::admin
      tags:
      - Sync
      summary: Update archives batch
      x-summary-source: derived
  /sync/backups:
    get:
      operationId: Fetch backups sync info
      description: Fetches the backups sync information.
      x-ExtJS: VaultManager.ListBackupsSyncInfo
      parameters:
      - name: agentId
        description: Filter archives by agent ID.
        required: false
        in: query
        schema:
          description: Filter archives by agent ID.
          type: string
          format: uuid
      - name: sourceUsnGt
        description: Show only archives with source Update Sequence Number (USN) greater than requested.
        required: false
        in: query
        schema:
          description: Show only archives with source Update Sequence Number (USN) greater than requested.
          type: integer
      - name: limit
        required: true
        in: query
        schema:
          type: integer
      - 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:
                description: Backup sync info list.
                type: array
                items:
                  type: object
                  additionalProperties: false
                  properties:
                    source_key:
                      type: string
                    source_usn:
                      type: integer
      security:
      - oauth2:
        - vault_manager::system_admin
        - vault_manager::admin
        - vault_manager::read
        - protection::readonly
      tags:
      - Sync
      summary: Fetch backups sync info
      x-summary-source: derived
    post:
      operationId: Update backups batch
      description: Updates a batch of backups.
      x-ExtJS: VaultManager.UpdateBackupsBulk
      requestBody:
        content:
          application/json:
            schema:
              description: Request to update backups set.
              anyOf:
              - oneOf:
                - type: object
                  required:
                  - full_resync
                  - vault_id
                  - archive_id
                  - add
                  properties:
                    full_resync:
                      enum:
                      - true
                    vault_id: {}
                    archive_id: {}
                    add: {}
                - type: object
                  required:
                  - full_resync
                  - add
                  properties:
                    full_resync:
                      enum:
                      - true
                    add: {}
                - type: object
                  required:
                  - add
                  properties:
                    add: {}
              - type: object
                required:
                - patch
                properties:
                  patch: {}
              - type: object
                required:
                - delete
                properties:
                  delete: {}
              type: object
              additionalProperties: false
              properties:
                add:
                  description: List of backups that should be created.
                  type: array
                  items:
                    allOf:
                    - description: Backup creation request.
                      allOf:
                      - $ref: '#/components/schemas/item0'
                      - type: object
                        required:
                        - change_tag
                        - created
                        - size
                        properties:
                          change_tag:
                            description: Tag to identify creation task.
                            type: string
                          archive_credentials_id:
                            description: Archive credentials ID.
                            type: string
                          created: {}
                          size: {}
                    - type: object
                      required:
                      - vault_id
                      - archive_id
                      - backup_id
                      properties:
                        vault_id: {}
                        archive_id: {}
                        backup_id: {}
                patch:
                  description: List of backups that should be patched. For non-existent backups, errors will be returned.
                  type: array
                  items:
                    allOf:
                    - description: Backup updating request, modified partial version of the Backup. Identified by `vault_id`, `archive_id` and `backup_id`.
                      allOf:
                      - $ref: '#/components/schemas/item0'
                      - type: object
                        properties:
                          archive_credentials_id:
                            description: Archive credentials ID.
                            type: string
                      type: object
                    - type: object
                      required:
                      - vault_id
                      - archive_id
                      - backup_id
                      properties:
                        vault_id: {}
                        archive_id: {}
                        backup_id: {}
                delete:
                  description: Specifies backups that should be deleted.
                  type: object
                  additionalProperties: false
                  properties:
                    change_tag:
                      description: User-defined tag of operation.
                      type: string
                    ids:
                      description: List of backups that should be deleted.
                      type: array
                      items:
                        $ref: '#/components/schemas/items_14'
                full_resync:
                  description: Specifies the full re-sync mode. If true, `add` array will be treated like a full and only full list of archive backups.
                  type: boolean
                vault_id:
                  $ref: '#/components/schemas/archive_id_15'
                archive_id:
                  $ref: '#/components/schemas/archive_id_15'
      responses:
        '200':
          description: 'Multiple operations have taken over backups with successful status for each backup

            can be viewed in the body of the response.

            '
          content:
            application/json:
              schema:
                description: Backup batch update result.
                type: object
                additionalProperties: false
                properties:
                  created:
                    description: IDs of created backups.
                    type: array
                    items:
                      $ref: '#/components/schemas/items_14'
                  errors:
                    description: List of errors per backup that encountered during batch operation execution.
                    type: array
                    items:
                      $ref: '#/components/schemas/error'
        '207':
          description: 'Multiple operations have taken over backups with different status for each backup

            can be viewed in the body of the response.

            '
          content:
            application/json:
              schema:
                description: Backup batch update result.
                type: object
                additionalProperties: false
                properties:
                  created:
                    description: IDs of created backups.
                    type: array
                    items:
                      $ref: '#/components/schemas/items_14'
                  errors:
                    description: List of errors per backup that encountered during batch operation execution.
                    type: array
                    items:
                      $ref: '#/components/schemas/error'
        '404':
          description: The involved archives/vaults/backups have not been found.
          content:
            application/json:
              schema:
                description: Backup batch update result.
                type: object
                additionalProperties: false
                properties:
                  created:
                    description: IDs of created backups.
                    type: array
                    items:
                      $ref: '#/components/schemas/items_14'
                  errors:
                    description: List of errors per backup that encountered during batch operation execution.
                    type: array
                    items:
                      $ref: '#/components/schemas/error'
      security:
      - oauth2:
        - vault_manager::system_admin
        - vault_manager::admin
      tags:
      - Sync
      summary: Update backups batch
      x-summary-source: derived
  /sync/vaults:
    get:
      operationId: Fetch vaults sync info
      description: Fetches the vaults sync information.
      x-ExtJS: VaultManager.ListVaultsSyncInfo
      parameters:
      - name: managingAgentId
        description: Filter vaults by agent ID.
        required: false
        in: query
        schema:
          description: Filter vaults by agent ID.
          type: string
          format: uuid
      - name: sourceUsnGt
        description: Show only vaults with source Update Sequence Number (USN) greater than requested.
        required: false
        in: query
        schema:
          description: Show only vaults with source Update Sequence Number (USN) greater than requested.
          type: integer
      - name: limit
        required: false
        in: query
        schema:
          type: integer
      - name: before
        description: 'Base64-encoded token obtained from the previous response.

          Points to the end of the page.

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

            Points to the end 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
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                description: Vault sync info list.
                type: array
                items:
                  type: object
                  additionalProperties: false
                  properties:
                    source_key:
                      type: string
                    source_usn:
                      type: integer
      security:
      - oauth2:
        - vault_manager::system_admin
        - vault_manager::admin
        - vault_manager::read
        - protection::readonly
      tags:
      - Sync
      summary: Fe

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