openapi: 3.0.0
info:
  version: 1.0-rev0
  title: Veeam Backup for AWS public API 1.0 Agents Cloud Browser API
  description: The Agents section defines paths and operations for managing recovery tokens used for bare metal recovery.
security:
- Bearer: []
tags:
- description: The Cloud Browser section defines paths and operations for retrieving information about cloud resources (compute or storage). Cloud browser helps you map a cloud folder with an object storage repository.
  name: Cloud Browser
paths:
  /api/v1/cloudBrowser:
    post:
      description: The HTTP POST request to the `/api/v1/cloudBrowser` path allows you to browse cloud resources (compute or storage) available for the specified storage account.
      operationId: BrowseCloudEntity
      parameters:
      - $ref: '#/components/parameters/apiVersionParam'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CloudBrowserSpec'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CloudBrowserModel'
          description: OK
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '500':
          $ref: '#/components/responses/InternalServerError'
      summary: Get Cloud Hierarchy
      tags:
      - Cloud Browser
      x-veeam-authorize:
        claims:
        - ViewCloudHierarchy
  /api/v1/cloudBrowser/newFolder:
    post:
      description: The HTTP POST request to the `/api/v1/cloudBrowser/newFolder` path allows you to create a new folder in the cloud infrastructure.<br><div class="note"><strong>NOTE</strong><br>The REST API does not create new containers, you can create a folder in an existing container only.</div>
      operationId: CreateNewCloudFolder
      parameters:
      - $ref: '#/components/parameters/apiVersionParam'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CloudBrowserNewFolderSpec'
      responses:
        '201':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EmptySuccessResponse'
          description: Cloud folder has been created.
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '500':
          $ref: '#/components/responses/InternalServerError'
      summary: New Folder
      tags:
      - Cloud Browser
      x-veeam-authorize:
        claims:
        - CreateCloudStorageFolder
components:
  schemas:
    CloudBrowserNewFolderSpec:
      allOf:
      - discriminator:
          mapping:
            AmazonS3: '#/components/schemas/AmazonS3BrowserDestinationSpec'
            AmazonSnowballEdge: '#/components/schemas/AmazonSnowballEdgeBrowserDestinationSpec'
            AzureBlob: '#/components/schemas/AzureBlobBrowserDestinationSpec'
            AzureDataBox: '#/components/schemas/AzureDataBoxBrowserDestinationSpec'
            GoogleCloud: '#/components/schemas/GoogleCloudStorageBrowserDestinationSpec'
            IBMCloud: '#/components/schemas/IBMCloudStorageBrowserDestinationSpec'
            S3Compatible: '#/components/schemas/S3CompatibleBrowserDestinationSpec'
            WasabiCloud: '#/components/schemas/WasabiCloudStorageBrowserDestinationSpec'
          propertyName: serviceType
        oneOf:
        - $ref: '#/components/schemas/AzureBlobBrowserDestinationSpec'
        - $ref: '#/components/schemas/AzureDataBoxBrowserDestinationSpec'
        - $ref: '#/components/schemas/AmazonS3BrowserDestinationSpec'
        - $ref: '#/components/schemas/S3CompatibleBrowserDestinationSpec'
        - $ref: '#/components/schemas/AmazonSnowballEdgeBrowserDestinationSpec'
        - $ref: '#/components/schemas/GoogleCloudStorageBrowserDestinationSpec'
        - $ref: '#/components/schemas/IBMCloudStorageBrowserDestinationSpec'
        - $ref: '#/components/schemas/WasabiCloudStorageBrowserDestinationSpec'
      - $ref: '#/components/schemas/BaseCloudBrowserNewFolderSpec'
    AmazonSnowballEdgeBrowserModel:
      allOf:
      - $ref: '#/components/schemas/BaseCloudBrowserModel'
      - properties:
          connectionPoint:
            description: Service point address and port number of the AWS Snowball Edge device.
            type: string
          hostId:
            description: ID of a server used to connect to the AWS Snowball Edge device.
            format: uuid
            type: string
          regions:
            description: Array of regions.
            items:
              $ref: '#/components/schemas/AmazonSnowballEdgeRegionBrowserModel'
            type: array
        type: object
    S3CompatibleBrowserModel:
      allOf:
      - $ref: '#/components/schemas/BaseCloudBrowserModel'
      - properties:
          connectionPoint:
            description: Service point address and port number of the S3 compatible storage.
            type: string
          hostId:
            description: ID of a server used to connect to the S3 compatible storage.
            format: uuid
            type: string
          regions:
            description: Array of regions.
            items:
              $ref: '#/components/schemas/S3CompatibleRegionBrowserModel'
            type: array
        type: object
    AzureVirtualNetworkBrowserModel:
      properties:
        subnets:
          description: Array of subnets.
          items:
            type: string
          type: array
        virtualNetworkName:
          description: Virtual network name.
          type: string
      type: object
    GoogleCloudStorageBrowserSpec:
      allOf:
      - $ref: '#/components/schemas/BaseCloudBrowserSpec'
      - properties:
          filters:
            $ref: '#/components/schemas/GoogleCloudStorageBrowserFilters'
          gatewayServerId:
            description: ID of a gateway server you want to use to connect to the object storage. Specify this parameter to check internet connection of the server. As a gateway server you can use the backup server or any Microsoft Windows or Linux server added to your backup infrastructure. By default, the backup server ID is used.
            format: uuid
            type: string
        type: object
    AmazonVPCBrowserModel:
      properties:
        securityGroups:
          description: Array of security groups.
          items:
            type: string
          type: array
        subnets:
          description: Array of VPC subnets.
          items:
            type: string
          type: array
        vpcName:
          description: VPC name.
          type: string
      type: object
    AmazonSnowballEdgeRegionBrowserModel:
      properties:
        buckets:
          description: Array of buckets located in the region.
          items:
            $ref: '#/components/schemas/AmazonSnowballEdgeBucketBrowserModel'
          type: array
        id:
          description: Region ID.
          type: string
        name:
          description: Region name.
          type: string
      type: object
    ECloudBrowserFolderType:
      description: Folder type.
      enum:
      - backup
      - archive
      type: string
    GoogleCloudStorageBucketBrowserModel:
      properties:
        folders:
          description: Array of folders located in the bucket.
          items:
            type: string
          type: array
        name:
          description: Bucket name.
          type: string
      type: object
    AzureResourceGroupBrowserModel:
      properties:
        resourceGroup:
          description: Resource group name.
          type: string
        virtualNetworks:
          description: Array of virtual networks available in the resource group.
          items:
            $ref: '#/components/schemas/AzureVirtualNetworkBrowserModel'
          type: array
      required:
      - resourceGroup
      - virtualNetworks
      type: object
    AzureComputeBrowserFilters:
      description: Azure Compute hierarchy filters.
      properties:
        hasNetworks:
          default: false
          description: If *true*, the result contains Azure resource groups with virtual networks only.
          type: boolean
        location:
          description: Filters compute resorces by Azure location name.
          type: string
        showAllStorageAccounts:
          default: false
          description: If *true*, the result contains compute resorces for all storage accounts. If *false*, the result contains compute resorces available for the specified storage account only.
          type: boolean
        subscriptionId:
          description: Filters compute resorces by ID that Veeam Backup & Replication assigned to the Azure subscription.
          type: string
      type: object
    AzureDataBoxBrowserSpec:
      allOf:
      - $ref: '#/components/schemas/BaseCloudBrowserSpec'
      - properties:
          gatewayServerId:
            description: ID of a gateway server you want to use to connect to the object storage. Specify this parameter to check internet connection of the server. As a gateway server you can use the backup server or any Microsoft Windows or Linux server added to your backup infrastructure. By default, the backup server ID is used.
            format: uuid
            type: string
          servicePoint:
            description: Service endpoint used to connect to the Azure Data Box object storage.
            type: string
        type: object
    AmazonS3BrowserSpec:
      allOf:
      - $ref: '#/components/schemas/BaseCloudBrowserSpec'
      - properties:
          filters:
            $ref: '#/components/schemas/AmazonS3CloudBrowserFilters'
          folderType:
            $ref: '#/components/schemas/ECloudBrowserFolderType'
          gatewayServerId:
            description: ID of a gateway server you want to use to connect to the object storage. Specify this parameter to check internet connection of the server. As a gateway server you can use the backup server or any Microsoft Windows or Linux server added to your backup infrastructure. By default, the backup server ID is used.
            format: uuid
            type: string
          regionType:
            $ref: '#/components/schemas/EAmazonRegionType'
        required:
        - regionType
        type: object
    GoogleCloudStorageRegionBrowserModel:
      properties:
        buckets:
          description: Array of buckets located in the region.
          items:
            $ref: '#/components/schemas/GoogleCloudStorageBucketBrowserModel'
          type: array
        id:
          description: Region ID.
          type: string
        name:
          description: Region name.
          type: string
      type: object
    Error:
      properties:
        errorCode:
          description: The error code is a string that uniquely identifies an error condition and should be understood by programs that detect and handle errors by type
          enum:
          - AccessDenied
          - ExpiredToken
          - InvalidToken
          - InvalidURI
          - MethodNotAllowed
          - NotFound
          - NotImplemented
          - ServiceUnavailable
          - UnexpectedContent
          - UnknownError
          type: string
        message:
          description: The error message contains a generic description of the error condition in English. It is intended for a human audience
          type: string
        resourceId:
          description: ID of the object that is involved in the error (or empty)
          type: string
      required:
      - errorCode
      - message
      type: object
    BaseCloudBrowserModel:
      properties:
        credentialsId:
          description: ID of the cloud credentials record.
          format: uuid
          type: string
        serviceType:
          $ref: '#/components/schemas/ECloudServiceType'
      type: object
    AzureComputeBrowserSpec:
      allOf:
      - $ref: '#/components/schemas/BaseCloudBrowserSpec'
      - properties:
          filters:
            $ref: '#/components/schemas/AzureComputeBrowserFilters'
        type: object
    AmazonSnowballEdgeBrowserSpec:
      allOf:
      - $ref: '#/components/schemas/BaseCloudBrowserSpec'
      - properties:
          gatewayServerId:
            description: ID of a gateway server you want to use to connect to the object storage. Specify this parameter to check internet connection of the server. As a gateway server you can use the backup server or any Microsoft Windows or Linux server added to your backup infrastructure. By default, the backup server ID is used.
            format: uuid
            type: string
          regionId:
            description: To connect to the AWS Snowball Edge device, specify the `snow` value.
            type: string
          servicePoint:
            description: Service point address and port number of the AWS Snowball Edge device.
            type: string
        type: object
    CloudBrowserSpec:
      allOf:
      - discriminator:
          mapping:
            AmazonEC2: '#/components/schemas/AmazonEC2BrowserSpec'
            AmazonS3: '#/components/schemas/AmazonS3BrowserSpec'
            AmazonSnowballEdge: '#/components/schemas/AmazonSnowballEdgeBrowserSpec'
            AzureBlob: '#/components/schemas/AzureBlobBrowserSpec'
            AzureCompute: '#/components/schemas/AzureComputeBrowserSpec'
            AzureDataBox: '#/components/schemas/AzureDataBoxBrowserSpec'
            GoogleCloud: '#/components/schemas/GoogleCloudStorageBrowserSpec'
            IBMCloud: '#/components/schemas/IBMCloudStorageBrowserSpec'
            S3Compatible: '#/components/schemas/S3CompatibleBrowserSpec'
            WasabiCloud: '#/components/schemas/WasabiCloudStorageBrowserSpec'
          propertyName: serviceType
        oneOf:
        - $ref: '#/components/schemas/AzureBlobBrowserSpec'
        - $ref: '#/components/schemas/AzureDataBoxBrowserSpec'
        - $ref: '#/components/schemas/AmazonS3BrowserSpec'
        - $ref: '#/components/schemas/S3CompatibleBrowserSpec'
        - $ref: '#/components/schemas/AmazonSnowballEdgeBrowserSpec'
        - $ref: '#/components/schemas/GoogleCloudStorageBrowserSpec'
        - $ref: '#/components/schemas/IBMCloudStorageBrowserSpec'
        - $ref: '#/components/schemas/AzureComputeBrowserSpec'
        - $ref: '#/components/schemas/AmazonEC2BrowserSpec'
        - $ref: '#/components/schemas/WasabiCloudStorageBrowserSpec'
      - $ref: '#/components/schemas/BaseCloudBrowserSpec'
    IBMCloudStorageBrowserDestinationSpec:
      allOf:
      - $ref: '#/components/schemas/BaseCloudBrowserNewFolderSpec'
      - properties:
          bucketName:
            description: Name of the bucket where you want to store your backup data.
            type: string
          connectionPoint:
            description: Endpoint address and port number of the IBM Cloud object storage.
            type: string
          hostId:
            description: ID of a server you want to use to connect to the object storage. You can use the backup server or any Microsoft Windows or Linux server added to your backup infrastructure. By default, the backup server ID is used.
            format: uuid
            type: string
          regionId:
            description: Region where the bucket is located.
            type: string
        required:
        - connectionPoint
        - regionId
        - bucketName
        type: object
    AzureBlobBrowserModel:
      allOf:
      - $ref: '#/components/schemas/BaseCloudBrowserModel'
      - properties:
          containers:
            description: Array of containers that reside in the Azure storage account.
            items:
              $ref: '#/components/schemas/AzureBlobContainerBrowserModel'
            type: array
          hostId:
            description: ID of a server used to connect to the object storage.
            format: uuid
            type: string
          regionType:
            $ref: '#/components/schemas/EAzureRegionType'
        type: object
    WasabiCloudStorageBrowserModel:
      allOf:
      - $ref: '#/components/schemas/BaseCloudBrowserModel'
      - properties:
          hostId:
            description: ID of a server used to connect to the object storage.
            format: uuid
            type: string
          regions:
            description: Array of regions.
            items:
              $ref: '#/components/schemas/WasabiCloudStorageRegionBrowserModel'
            type: array
        type: object
    EmptySuccessResponse:
      description: Empty success response (200, 201, 204).
      type: object
    AzureBlobBrowserSpec:
      allOf:
      - $ref: '#/components/schemas/BaseCloudBrowserSpec'
      - properties:
          folderType:
            $ref: '#/components/schemas/ECloudBrowserFolderType'
          gatewayServerId:
            description: ID of a gateway server you want to use to connect to the object storage. Specify this parameter to check internet connection of the server. As a gateway server you can use the backup server or any Microsoft Windows or Linux server added to your backup infrastructure. By default, the backup server ID is used.
            format: uuid
            type: string
          regionType:
            $ref: '#/components/schemas/EAzureRegionType'
        type: object
    IBMCloudStorageBrowserSpec:
      allOf:
      - $ref: '#/components/schemas/BaseCloudBrowserSpec'
      - properties:
          gatewayServerId:
            description: ID of a gateway server you want to use to connect to the object storage. Specify this parameter to check internet connection of the server. As a gateway server you can use the backup server or any Microsoft Windows or Linux server added to your backup infrastructure. By default, the backup server ID is used.
            format: uuid
            type: string
          regionId:
            description: Region of the IBM Cloud object storage.
            type: string
          servicePoint:
            description: Endpoint address and port number of the IBM Cloud object storage.
            type: string
        required:
        - regionId
        - servicePoint
        type: object
    AmazonS3BucketBrowserModel:
      properties:
        folders:
          description: Array of folders located in the bucket.
          items:
            type: string
          type: array
        name:
          description: Bucket name.
          type: string
      type: object
    IBMCloudStorageRegionBrowserModel:
      properties:
        buckets:
          description: Array of buckets located in the region.
          items:
            $ref: '#/components/schemas/IBMCloudStorageBucketBrowserModel'
          type: array
        id:
          description: Region ID.
          type: string
        name:
          description: Region name.
          type: string
      type: object
    AzureSubscriptionBrowserModel:
      properties:
        azureSubscriptionId:
          description: Original Azure subscription ID.
          type: string
        id:
          description: ID that Veeam Backup & Replication assigned to the Azure subscription.
          format: uuid
          type: string
        locations:
          description: Array of Azure geographic regions.
          items:
            $ref: '#/components/schemas/AzureLocationBrowserModel'
          type: array
      required:
      - id
      - resourceGroups
      - virtualNetworks
      - storageAccounts
      type: object
    AzureBlobBrowserDestinationSpec:
      allOf:
      - $ref: '#/components/schemas/BaseCloudBrowserNewFolderSpec'
      - properties:
          containerName:
            description: Name of the container where you want to store your backup data.
            type: string
          folderType:
            $ref: '#/components/schemas/ECloudBrowserFolderType'
          hostId:
            description: ID of a server you want to use to connect to the object storage. You can use the backup server or any Microsoft Windows or Linux server added to your backup infrastructure. By default, the backup server ID is used.
            format: uuid
            type: string
          regionType:
            $ref: '#/components/schemas/EAzureRegionType'
        required:
        - regionType
        - containerName
        type: object
    WasabiCloudStorageBrowserSpec:
      allOf:
      - $ref: '#/components/schemas/BaseCloudBrowserSpec'
      - properties:
          gatewayServerId:
            description: ID of a gateway server you want to use to connect to the object storage. Specify this parameter to check internet connection of the server. As a gateway server you can use the backup server or any Microsoft Windows or Linux server added to your backup infrastructure. By default, the backup server ID is used.
            format: uuid
            type: string
          regionId:
            description: Region ID.
            type: string
        required:
        - regionId
        type: object
    AmazonS3CloudBrowserFilters:
      description: Amazon S3 hierarchy filters.
      properties:
        bucketName:
          description: Filters buckets by bucket name.
          type: string
        regionId:
          description: Filters buckets by AWS region where an Amazon S3 data center is located.
          type: string
      required:
      - regionId
      type: object
    IBMCloudStorageBrowserModel:
      allOf:
      - $ref: '#/components/schemas/BaseCloudBrowserModel'
      - properties:
          hostId:
            description: ID of a server used to connect to the object storage.
            format: uuid
            type: string
          regions:
            description: Array of regions.
            items:
              $ref: '#/components/schemas/IBMCloudStorageRegionBrowserModel'
            type: array
        type: object
    EAzureRegionType:
      description: Region where your Microsoft Azure container is located.
      enum:
      - China
      - Germany
      - Global
      - Government
      type: string
    GoogleCloudStorageBrowserModel:
      allOf:
      - $ref: '#/components/schemas/BaseCloudBrowserModel'
      - properties:
          hostId:
            description: ID of a server used to connect to the object storage.
            format: uuid
            type: string
          regions:
            description: Array of regions.
            items:
              $ref: '#/components/schemas/GoogleCloudStorageRegionBrowserModel'
            type: array
        type: object
    WasabiCloudStorageRegionBrowserModel:
      properties:
        buckets:
          description: Array of buckets located in the region.
          items:
            $ref: '#/components/schemas/WasabiCloudStorageBucketBrowserModel'
          type: array
        id:
          description: Region ID.
          type: string
        name:
          description: Region name.
          type: string
      type: object
    S3CompatibleRegionBrowserModel:
      properties:
        buckets:
          description: Array of buckets located in the region.
          items:
            $ref: '#/components/schemas/S3CompatibleBucketBrowserModel'
          type: array
        id:
          description: Region ID.
          type: string
        name:
          description: Region name.
          type: string
      type: object
    AmazonS3BrowserModel:
      allOf:
      - $ref: '#/components/schemas/BaseCloudBrowserModel'
      - properties:
          hostId:
            description: ID of a server used to connect to the object storage.
            format: uuid
            type: string
          regionType:
            $ref: '#/components/schemas/EAmazonRegionType'
          regions:
            description: Array of AWS regions belonged to the region type.
            items:
              $ref: '#/components/schemas/AmazonS3RegionBrowserModel'
            type: array
        required:
        - hostId
        - regionType
        type: object
    AmazonEC2BrowserModel:
      allOf:
      - $ref: '#/components/schemas/BaseCloudBrowserModel'
      - properties:
          hostId:
            description: ID of a server used to connect to the object storage.
            format: uuid
            type: string
          regionType:
            $ref: '#/components/schemas/EAmazonRegionType'
          regions:
            description: Array of regions.
            items:
              $ref: '#/components/schemas/AmazonEC2RegionBrowserModel'
            type: array
        required:
        - hostId
        - regionType
        - regions
        type: object
    S3CompatibleBrowserDestinationSpec:
      allOf:
      - $ref: '#/components/schemas/BaseCloudBrowserNewFolderSpec'
      - properties:
          bucketName:
            description: Name of the bucket where you want to store your backup data.
            type: string
          connectionPoint:
            description: Endpoint address and port number of the S3 compatible storage.
            type: string
          hostId:
            description: ID of a server you want to use to connect to the object storage. You can use the backup server or any Microsoft Windows or Linux server added to your backup infrastructure. By default, the backup server ID is used.
            format: uuid
            type: string
          regionId:
            description: Region where the bucket is located.
            type: string
        required:
        - connectionPoint
        - regionId
        - bucketName
        type: object
    AmazonEC2BrowserFilters:
      description: Amazon EC2 hierarchy filters.
      properties:
        regionId:
          description: Filters Amazon EC2 resources by AWS region.
          type: string
      required:
      - regionId
      type: object
    GoogleCloudStorageBrowserFilters:
      description: Google Cloud hierarchy filters.
      properties:
        bucketName:
          description: Bucket name.
          type: string
        regionId:
          description: Google Cloud data center region.
          type: string
      required:
      - regionId
      type: object
    AzureDataBoxBrowserModel:
      allOf:
      - $ref: '#/components/schemas/BaseCloudBrowserModel'
      - properties:
          containers:
            description: Array of containers that reside in the Azure storage account.
            items:
              $ref: '#/components/schemas/AzureDataBoxContainerBrowserModel'
            type: array
          hostId:
            description: ID of a server used to connect to the object storage.
            format: uuid
            type: string
        type: object
    IBMCloudStorageBucketBrowserModel:
      properties:
        folders:
          description: Array of folders located in the bucket.
          items:
            type: string
          type: array
        name:
          description: Bucket name.
          type: string
      type: object
    AzureDataBoxContainerBrowserModel:
      properties:
        folders:
          description: Array of folders located in the container.
          items:
            type: string
          type: array
        name:
          description: Container name.
          type: string
      type: object
    AmazonSnowballEdgeBucketBrowserModel:
      properties:
        folders:
          description: Array of folders located in the bucket.
          items:
            type: string
          type: array
        name:
          description: Bucket name.
          type: string
      type: object
    CloudBrowserModel:
      allOf:
      - discriminator:
          mapping:
            AmazonEC2: '#/components/schemas/AmazonEC2BrowserModel'
            AmazonS3: '#/components/schemas/AmazonS3BrowserModel'
            AmazonSnowballEdge: '#/components/schemas/AmazonSnowballEdgeBrowserModel'
            AzureBlob: '#/components/schemas/AzureBlobBrowserModel'
            AzureCompute: '#/components/schemas/AzureComputeBrowserModel'
            AzureDataBox: '#/components/schemas/AzureDataBoxBrowserModel'
            GoogleCloud: '#/components/schemas/GoogleCloudStorageBrowserModel'
            IBMCloud: '#/components/schemas/IBMCloudStorageBrowserModel'
            S3Compatible: '#/components/schemas/S3CompatibleBrowserModel'
            WasabiCloud: '#/components/schemas/WasabiCloudStorageBrowserModel'
          propertyName: serviceType
        oneOf:
        - $ref: '#/components/schemas/AzureBlobBrowserModel'
        - $ref: '#/components/schemas/AzureDataBoxBrowserModel'
        - $ref: '#/components/schemas/AmazonS3BrowserModel'
        - $ref: '#/components/schemas/AmazonSnowballEdgeBrowserModel'
        - $ref: '#/components/schemas/S3CompatibleBrowserModel'
        - $ref: '#/components/schemas/GoogleCloudStorageBrowserModel'
        - $ref: '#/components/schemas/IBMCloudStorageBrowserModel'
        - $ref: '#/components/schemas/AzureComputeBrowserModel'
        - $ref: '#/components/schemas/AmazonEC2BrowserModel'
        - $ref: '#/components/schemas/WasabiCloudStorageBrowserModel'
      - $ref: '#/components/schemas/BaseCloudBrowserModel'
    AmazonEC2BrowserSpec:
      allOf:
      - $ref: '#/components/schemas/BaseCloudBrowserSpec'
      - properties:
          filters:
            $ref: '#/components/schemas/AmazonEC2BrowserFilters'
          regionType:
            $ref: '#/components/schemas/EAmazonRegionType'
        required:
        - regionType
        type: object
    AmazonS3BrowserDestinationSpec:
      allOf:
      - $ref: '#/components/schemas/BaseCloudBrowserNewFolderSpec'
      - properties:
          bucketName:
            description: Name of the bucket where you want to store your backup data.
            type: string
          folderType:
            $ref: '#/components/schemas/ECloudBrowserFolderType'
          hostId:
            description: ID of a server you want to use to connect to the object storage. You can use the backup server or any Microsoft Windows or Linux server added to your backup infrastructure. By default, the backup server ID is used.
            format: uuid
            type: string
          regionId:
            description: AWS region where the Amazon S3 bucket is located.
            type: string
          regionType:
            $ref: '#/components/schemas/EAmazonRegionType'
        required:
        - regionType
        - regionId
        - bucketName
        type: object
    ECloudServiceType:
      description: Type of cloud service.
      enum:
      - AzureBlob
      - AzureDataBox
      - AmazonS3
      - AmazonEC2
      - S3Compatible
      - AmazonSnowballEdge
      - GoogleCloud
      - IBMCloud
      - AzureCompute
      - WasabiCloud
      type: string
    S3CompatibleBucketBrowserModel:
      properties:
        folders:
          description: Array of folders located in the bucket.
          items:
            type: string
          type: array
        name:
          description: Bucket name.
          type: string
      type: object
    AzureBlobContainerBrowserModel:
      properties:
        folders:
          description: Array of folders loated in the container.
          items:
            type: string
          type: array
        name:
          description: Container name.
          type: string
      type: object
    AmazonEC2RegionBrowserModel:
      properties:
        instanceTypes:
          description: Array of Amazon instance types.
          items:
            type: string
          type: array
        regionId:
          description: Region ID.
          type: string
        vpcs:
          description: Array of Amazon Virtual Private Cloud (Amazon VPC) networks.
          items:
            $ref: '#/components/schemas/AmazonVPCBrowserModel'
          type: array
      type: object
    AzureDataBoxBrowserDestinationSpec:
      allOf:
      - $ref: '#/components/schemas/BaseCloudBrowserNewFolderSpec'
      - properties:
          containerName:
            description: Name of the container where you want to store your backup data.
            type: string
          hostId:
            description: ID of a server you want to use to connect to the object storage. You can use the backup server or any Microsoft Windows or Linux server added to your backup infrastructure. By default, the backup server ID is used.
            format: uuid
            type: string
          servicePoint:
            description: Service endpoint address of the Azure Data Box device.
            type: string
        required:
        - servicePoint
        - containerName
        type: object
    WasabiCloudStorageBrowserDestinationSpec:
      allOf:
      - $ref: '#/components/schemas/BaseCloudBrowserNewFolderSpec'
      - properties:
          bucketName:
            description: Name of the bucket where you want to store your backup data.
            type: string
          hostId:
            description: ID of a server you want to use to connect to the object storage. You can use the backup server or any Microsoft Windows or Linux server added to your backup infrastructure. By default, the backup server ID is used.
            format: uuid
            type: string
          regionId:
            description: Region where the bucket is located.
            type: string
        required:
        - regionId
        - bucketName
        type: object
    AzureComputeBrowserModel:
      allOf:
      - $ref: '#/components/schemas/BaseCloudBrowserModel'
      - properties:
          regionType:
            description: Azure region type.
            type: string
          subscriptions:
            description: Array of Azure subscriptions associated with the account.
            items:
              $ref: '#/components/schemas/AzureSubscriptionBrowserModel'
            type: array
        type: object
    GoogleCloudStorageBrowserDestinationSpec:
      allOf:
      - $ref: '#/components/schemas/BaseCloudBrowserNewFolderSpec'
      - properties:
          bucketName:
            description: Name of the bucket where you want to store your backup data.
            type: string
          hostId:
            description: ID of a server you want to use to connect to the object storage. You can use the backup server or any Microsoft Windows or Linux server added to your backup infrastructure. By default, the backup server ID is used.
            format: uuid
            type: string
          regionId:
            description: Data center region where the bucket is located.
            type: string
        required:
        - regionId
        - bucketName
        type: object
    AmazonSnowballEdgeBrowserDestinationSpec:
      allOf:
      - $ref: '#/components/schemas/BaseCloudBrowserNewFolderSpec'
      - properties:
          bucketName:
            description: Name of the bucket where you want to store your backup data.
            type: string
          connectionPoint:
            description: Service point address and port number of the AWS Snowball Edge device.
            type: string
          hostId:
            description: ID of a server you want to use to connect to the object storage. You can use the backup server or any Microsoft Windows or Linux server added to your backup infrastructure. By default, the backup server ID is used.
            format: uuid
            type: string
          regionId:
            description: For AWS Snowball Edge, the region is *snow*.
            type: string
        required:
        - connectionPoint
        - regionId
        - bucketName
        type: object
    BaseCloudBrowserSpec:
      properties:
        credentialsId:
          description: ID of the object storage account (for browsing either storage or compute infrastructure).
          format: uuid
          type: string
        serviceType:
          $ref: '#/components/schemas/ECloudServiceType'
      type: object
    AmazonS3RegionBrowserModel:
      description: AWS region.
      properties:
        buckets:
          description: Array of buckets located in the region.
          items:
            $ref: '#/components/schemas/AmazonS3BucketBrowserModel'
          type: array
        id:
          description: Region ID.
          type: string
        name:
          description: Region name.
          type: string
      type: object
    AzureLocationBrowserModel:
      properties:
        location:
          description: Location name.
          type: string
        resourceGroups:
          description: Array of Azure resource groups.
          items:
            $ref: '#/components/schemas/AzureResourceGroupBrowserModel'
          type: array
        storageAccounts:
          description: Array of storage accounts associated with the location.
          items:
            $ref: '#/components/schemas/AzureStorageAccountBrowserModel'
          type: array
      required:
      - location
      - storageAccounts
      - resourceGroups
      type: object
    EAmazonRegionType:
      description: AWS region type.
      enum:
      - China
      - Global
      - Government
      type: string
    BaseCloudBrowserNewFolderSpec:
      properties:
        credentialsId:
          description: ID of a cloud credentials record requiered to connect to the object storage.
          format: uuid
          type: string
        newFolderName:
          description: Name of the new folder.
          type: string
        serviceType:
          $ref: '#/components/schemas/ECloudServiceType'
      type: object
    WasabiCloudStorageBucketBrowserModel:
      properties:
        folders:
          description: Array of folders located in the bucket.
          items:
            type: string
          type: array
        name:
          description: Bucket name.
          type: string
      type: object
    AzureStorageAccountBrowserModel:
      properties:
        instanceSizes:
          description: Array of available instance sizes.
          items:
            type: string
          type: array
        storageAccountName:
          description: Account name.
          type: string
      type: object
    S3CompatibleBrowserSpec:
      allOf:
      - $ref: '#/components/schemas/BaseCloudBrowserSpec'
      - properties:
          gatewayServerId:
            description: ID of a gateway server you want to use to connect to the object storage. Specify this parameter to check internet connection of the server. As a gateway server you can use the backup server or any Microsoft Windows or Linux server added to your backup infrastructure. By default, the backup server ID is used.
            format: uuid
            type: string
          regionId:
            description: Region where the S3 compatible storage is located.
            type: string
          servicePoint:
            description: Service point address of the S3 compatible storage.
            type: string
        type: object
  responses:
    Forbidden:
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
      description: Forbidden. The user sending the request does not have adequate privileges to access one or more objects specified in the request.
    Unauthorized:
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
      description: Unauthorized. The authorization header has been expected but not found (or found but is expired).
    BadRequest:
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
      description: Bad request. This error is related to POST/PUT requests. The request body is malformed, incomplete or otherwise invalid.
    InternalServerError:
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
      description: Internal server error. The request has been received but could not be completed because of an internal error at the server side.
  parameters:
    apiVersionParam:
      description: Version and revision of the client REST API. Must be in the following format&#58; `<version>-<revision>`.
      in: header
      name: x-api-version
      required: true
      schema:
        default: 1.1-rev0
        type: string
  securitySchemes:
    Bearer:
      name: Authorization
      in: header
      type: apiKey
      description: Bearer \<JWT\>