Portworx OpenStorageCloudBackup API

openapi: 3.2.0
info:
  title: OpenStorage SDK OpenStorageAlerts Open Storage Cloud Backup API
  version: 0.186.0
servers:
- url: https://libopenstorage.github.io/
  description: Base URL declared by the provider in apis.yml (roadmap#122).
security:
- bearerAuth: []
tags:
- name: OpenStorageCloudBackup
paths:
  /v1/cloudbackups:
    post:
      description: Requires access AccessType.Read of volume
      operationId: OpenStorageCloudBackup_Create
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/apiSdkCloudBackupCreateRequest'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/apiSdkCloudBackupCreateResponse'
          description: A successful response.
        default:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/runtimeError'
          description: An unexpected error response.
      summary: 'Creates a backup request for a specified volume. Use

        OpenStorageCloudBackup.Status() to get the current status of the

        backup request.'
      tags:
      - OpenStorageCloudBackup
  /v1/cloudbackups/backup/{backup_id}:
    delete:
      operationId: OpenStorageCloudBackup_Delete
      parameters:
      - description: ID is the ID of the cloud backup
        in: path
        name: backup_id
        required: true
        schema:
          type: string
      - description: Credential id is the credential for cloud to be used for the request.
        in: query
        name: credential_id
        required: false
        schema:
          type: string
      - description: 'Force Delete cloudbackup even if there are dependencies. This may be

          needed if the backup is an incremental backup and subsequent backups

          depend on this backup specified by `backup_id`.'
        in: query
        name: force
        required: false
        schema:
          type: boolean
      - description: Bucket name to which cloud backup belongs to.
        in: query
        name: bucket
        required: false
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/apiSdkCloudBackupDeleteResponse'
          description: A successful response.
        default:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/runtimeError'
          description: An unexpected error response.
      summary: 'Deletes a backup stored in the cloud. If the backup is an incremental

        backup and other backups are dependent on it, it will not be able to be deleted.'
      tags:
      - OpenStorageCloudBackup
  /v1/cloudbackups/catalog:
    post:
      operationId: OpenStorageCloudBackup_Catalog
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/apiSdkCloudBackupCatalogRequest'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/apiSdkCloudBackupCatalogResponse'
          description: A successful response.
        default:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/runtimeError'
          description: An unexpected error response.
      summary: Catalog returns a list of the contents in the backup
      tags:
      - OpenStorageCloudBackup
  /v1/cloudbackups/deleteall:
    post:
      operationId: OpenStorageCloudBackup_DeleteAll
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/apiSdkCloudBackupDeleteAllRequest'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/apiSdkCloudBackupDeleteAllResponse'
          description: A successful response.
        default:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/runtimeError'
          description: An unexpected error response.
      summary: DeleteAll deletes all the backups in the cloud for the specified volume.
      tags:
      - OpenStorageCloudBackup
  /v1/cloudbackups/enumerate/filters:
    post:
      operationId: OpenStorageCloudBackup_EnumerateWithFilters
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/apiSdkCloudBackupEnumerateWithFiltersRequest'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/apiSdkCloudBackupEnumerateWithFiltersResponse'
          description: A successful response.
        default:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/runtimeError'
          description: An unexpected error response.
      summary: Return a list of backups for the specified volume
      tags:
      - OpenStorageCloudBackup
  /v1/cloudbackups/group:
    post:
      description: This will only backup volumes which the user has read_access to.
      operationId: OpenStorageCloudBackup_GroupCreate
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/apiSdkCloudBackupGroupCreateRequest'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/apiSdkCloudBackupGroupCreateResponse'
          description: A successful response.
        default:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/runtimeError'
          description: An unexpected error response.
      summary: 'Creates a group backup request for a specified group. Use

        OpenStorageCloudBackup.Status() to get the current status of the

        backup request.'
      tags:
      - OpenStorageCloudBackup
  /v1/cloudbackups/history/{src_volume_id}:
    get:
      operationId: OpenStorageCloudBackup_History
      parameters:
      - description: 'This optional value defines which history of backups is being

          requested. If not provided, it will return the history for all volumes.'
        in: path
        name: src_volume_id
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/apiSdkCloudBackupHistoryResponse'
          description: A successful response.
        default:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/runtimeError'
          description: An unexpected error response.
      summary: History returns a list of backups for a specified volume
      tags:
      - OpenStorageCloudBackup
  /v1/cloudbackups/restore:
    post:
      operationId: OpenStorageCloudBackup_Restore
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/apiSdkCloudBackupRestoreRequest'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/apiSdkCloudBackupRestoreResponse'
          description: A successful response.
        default:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/runtimeError'
          description: An unexpected error response.
      summary: 'Restore creates a new volume from a backup id. The newly created volume

        has an ha_level (number of replicas) of only 1. To increase the number of

        replicas, use OpenStorageVolume.Set() to change the ha_level.'
      tags:
      - OpenStorageCloudBackup
  /v1/cloudbackups/schedules:
    get:
      operationId: OpenStorageCloudBackup_SchedEnumerate
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/apiSdkCloudBackupSchedEnumerateResponse'
          description: A successful response.
        default:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/runtimeError'
          description: An unexpected error response.
      summary: Enumerate cloud backup schedules
      tags:
      - OpenStorageCloudBackup
    post:
      operationId: OpenStorageCloudBackup_SchedCreate
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/apiSdkCloudBackupSchedCreateRequest'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/apiSdkCloudBackupSchedCreateResponse'
          description: A successful response.
        default:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/runtimeError'
          description: An unexpected error response.
      summary: Create cloud backup schedule
      tags:
      - OpenStorageCloudBackup
    put:
      operationId: OpenStorageCloudBackup_SchedUpdate
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/apiSdkCloudBackupSchedUpdateRequest'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/apiSdkCloudBackupSchedUpdateResponse'
          description: A successful response.
        default:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/runtimeError'
          description: An unexpected error response.
      summary: Update existing cloud backup schedule
      tags:
      - OpenStorageCloudBackup
  /v1/cloudbackups/schedules/{backup_schedule_id}:
    delete:
      operationId: OpenStorageCloudBackup_SchedDelete
      parameters:
      - description: Id of cloud backup to delete
        in: path
        name: backup_schedule_id
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/apiSdkCloudBackupSchedDeleteResponse'
          description: A successful response.
        default:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/runtimeError'
          description: An unexpected error response.
      summary: Delete cloud backup schedule
      tags:
      - OpenStorageCloudBackup
  /v1/cloudbackups/size:
    get:
      operationId: OpenStorageCloudBackup_Size
      parameters:
      - description: 'BackupId is a value which is used to get information on the

          size of the specified backup.'
        in: query
        name: backup_id
        required: false
        schema:
          type: string
      - description: Credential id describe the credentials for the cloud.
        in: query
        name: credential_id
        required: false
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/apiSdkCloudBackupSizeResponse'
          description: A successful response.
        default:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/runtimeError'
          description: An unexpected error response.
      summary: Size returns the size of any cloud backups of a volume
      tags:
      - OpenStorageCloudBackup
  /v1/cloudbackups/statechange:
    post:
      operationId: OpenStorageCloudBackup_StateChange
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/apiSdkCloudBackupStateChangeRequest'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/apiSdkCloudBackupStateChangeResponse'
          description: A successful response.
        default:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/runtimeError'
          description: An unexpected error response.
      summary: StateChange can be used to stop, pause, and restart a backup
      tags:
      - OpenStorageCloudBackup
  /v1/cloudbackups/status:
    post:
      operationId: OpenStorageCloudBackup_Status
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/apiSdkCloudBackupStatusRequest'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/apiSdkCloudBackupStatusResponse'
          description: A successful response.
        default:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/runtimeError'
          description: An unexpected error response.
      summary: Status returns the status of any cloud backups of a volume
      tags:
      - OpenStorageCloudBackup
components:
  schemas:
    apiPureFileSpec:
      properties:
        export_rules:
          type: string
        full_vol_name:
          type: string
        nfs_endpoint:
          type: string
      title: PureFileSpec is the spec for proxying a volume on pure_file backends
      type: object
    protobufAny:
      properties:
        type_url:
          type: string
        value:
          format: byte
          type: string
      type: object
    apiSdkCloudBackupScheduleInfo:
      properties:
        credential_id:
          title: The cloud credential used with this schedule
          type: string
        full:
          description: Full indicates if scheduled backups should always be full and never incremental.
          type: boolean
        group_id:
          title: GroupId indicates the group of volumes for which this schedule applies
          type: string
        labels:
          additionalProperties:
            type: string
          title: labels indicates group of volumes with similar labels for which this schedule applies
          type: object
        max_backups:
          format: uint64
          title: 'MaxBackups indicates when to force full backup to cloud. If RetentionDays

            is not specified or is 0 (older scheme), this is also the maximum number

            of scheduled backups retained in the cloud. Older backups are deleted'
          type: string
        retention_days:
          format: int64
          title: 'Number of days that Scheduled CloudBackups will be kept after which they

            are deleted'
          type: integer
        schedules:
          items:
            $ref: '#/components/schemas/apiSdkSchedulePolicyInterval'
          title: Schedules are the frequencies of the backup
          type: array
        src_volume_id:
          title: The schedule's source volume
          type: string
      title: 'SdkCloudBackupScheduleInfo describes a schedule for volume backups to

        a cloud provider'
      type: object
    apiSdkCloudBackupStatusResponse:
      properties:
        statuses:
          additionalProperties:
            $ref: '#/components/schemas/apiSdkCloudBackupStatus'
          description: 'Statuses is list of currently active/failed/done backup/restores where

            the key is the id of the task performing backup/restore.'
          type: object
      title: Defines a response containing the status of the backups for a specified volume
      type: object
    apiIoThrottle:
      properties:
        read_bw_mbytes:
          format: int64
          type: integer
        read_iops:
          format: int64
          type: integer
        write_bw_mbytes:
          format: int64
          type: integer
        write_iops:
          format: int64
          type: integer
      title: 'IoThrottle defines IO throttle limits for a volume

        read_iops : maximum read iops this volume is allowed

        write_iops : maximum write iops this volume is allowed

        read_bw_mbytes  : maximum read bandwidth this volume is allowed in MegaBytes

        write_bw_mbytes : maximum write bandwidth this volume is allowed in MegaBytes'
      type: object
    apiSdkCloudBackupStateChangeRequest:
      properties:
        requested_state:
          $ref: '#/components/schemas/apiSdkCloudBackupRequestedState'
        task_id:
          title: 'Describes the backup/restore task

            state change is being requested'
          type: string
      title: 'Defines a request to change the state of a backup or restore to or

        from a cloud provider'
      type: object
    apiSdkCloudBackupHistoryItem:
      properties:
        src_volume_id:
          title: SrcVolumeID is volume ID which was backedup
          type: string
        status:
          $ref: '#/components/schemas/apiSdkCloudBackupStatusType'
        timestamp:
          format: date-time
          title: TimeStamp is the time at which either backup completed/failed
          type: string
      title: 'SdkCloudBackupHistoryItem contains information about a backup for a

        specific volume'
      type: object
    apiRestoreVolSnashotSchedule:
      properties:
        schedule:
          type: string
      type: object
    apiSdkCloudBackupStatus:
      properties:
        backup_id:
          title: This is the id as represented by the cloud provider
          type: string
        bytes_done:
          format: uint64
          title: BytesDone indicates total Bytes uploaded/downloaded
          type: string
        bytes_total:
          format: uint64
          title: BytesTotal is the total number of bytes being transferred
          type: string
        completed_time:
          format: date-time
          title: CompletedTime indicates Op's completed time
          type: string
        credential_id:
          title: CredentialId is the credential used for cloud with this backup/restore op
          type: string
        eta_seconds:
          format: int64
          title: ETASeconds is the number of seconds for cloud backup completion
          type: string
        group_id:
          title: string group_id volume's group id if this was group cloud backup
          type: string
        info:
          items:
            type: string
          title: Info currently indicates the failure cause for failed backup/restore
          type: array
        node_id:
          title: NodeID is the ID of the node where this Op is active
          type: string
        optype:
          $ref: '#/components/schemas/apiSdkCloudBackupOpType'
        src_volume_id:
          title: 'SourceVolumeID is the the volume that is either being backed up to cloud

            or target volume to which a backup is being restored'
          type: string
        start_time:
          format: date-time
          title: StartTime indicates Op's start time
          type: string
        status:
          $ref: '#/components/schemas/apiSdkCloudBackupStatusType'
      title: SdkCloudBackupStatus defines the status of a backup stored by a cloud provider
      type: object
    apiIoProfile:
      default: IO_PROFILE_SEQUENTIAL
      enum:
      - IO_PROFILE_SEQUENTIAL
      - IO_PROFILE_RANDOM
      - IO_PROFILE_DB
      - IO_PROFILE_DB_REMOTE
      - IO_PROFILE_CMS
      - IO_PROFILE_SYNC_SHARED
      - IO_PROFILE_AUTO
      - IO_PROFILE_NONE
      - IO_PROFILE_JOURNAL
      - IO_PROFILE_AUTO_JOURNAL
      type: string
    apiSdkCloudBackupEnumerateWithFiltersResponse:
      properties:
        backups:
          items:
            $ref: '#/components/schemas/apiSdkCloudBackupInfo'
          type: array
        continuation_token:
          title: 'if this is not an empty string, callers must pass this to get next list of

            backups'
          type: string
      title: Defines a response which lists all the backups stored by a cloud provider
      type: object
    apiSdkCloudBackupEnumerateWithFiltersRequest:
      description: '* For a specific volume in current cluster: Set `src_volume_id` to your desired volume id

        and do not provide `cluster_id` and `all`.

        * For a specific volume in a specific cluster: Set `src_volume_id` to your desired volume id

        and specify `cluster_id`.

        * For a specific volume in all clusters: Set `src_volume_id` to your desired volume id

        and set `all` to true, do not provide `cluster_id`.

        * For all volumes in current cluster: do not provide `cluster_id`, `volume_id` and `all`.

        * For all volumes in a specific cluster: Set `cluster_id` to your desired cluster id

        and do not provide `volume_id` and `all`.

        * For all volumes in all clusters: Set `all` to true do not provide `volume_id` and `cluster_id`.'
      properties:
        all:
          description: (optional) All indicates if the request should show cloud backups for all clusters or the current cluster.
          type: boolean
        cloud_backup_id:
          title: 'If one wants to enumerate known backup, set this field to the backup ID

            naming format :clusteruuidORbicketname/srcVolId-snapId(-incr)'
          type: string
        cluster_id:
          title: (optional) Cluster id specifies the cluster for the request
          type: string
        continuation_token:
          description: 'Returned in the enumerate response if not all of the backups could be returned in the

            response.'
          type: string
        credential_id:
          title: Credential id is the credential for cloud to be used for the request
          type: string
        max_backups:
          format: uint64
          title: (optional) if caller wished to limit number of backups returned by enumerate
          type: string
        metadata_filter:
          additionalProperties:
            type: string
          title: (optional) Enumerates backups that have tags of this type
          type: object
        missing_src_volumes:
          title: 'To enumerate cloudbackups for which source volumes do not exist in this

            cluster'
          type: boolean
        src_volume_id:
          description: (optional) Source id of the volume for the request.
          type: string
        status_filter:
          $ref: '#/components/schemas/apiSdkCloudBackupStatusType'
      title: 'Defines a request to list the backups stored by a cloud provider.

        The following combinations can be used to get cloud backup information:'
      type: object
    apiSdkCloudBackupInfo:
      properties:
        cluster_type:
          $ref: '#/components/schemas/apiSdkCloudBackupClusterType'
        id:
          title: This is the id as represented by the cloud provider
          type: string
        metadata:
          additionalProperties:
            type: string
          title: Metadata associated with the backup
          type: object
        namespace:
          title: k8s namespace to which this backup belongs to
          type: string
        src_volume_id:
          title: Source volumeID of the backup
          type: string
        src_volume_name:
          title: Name of the sourceVolume of the backup
          type: string
        status:
          $ref: '#/components/schemas/apiSdkCloudBackupStatusType'
        timestamp:
          format: date-time
          title: 'Timestamp is the timestamp at which the source volume

            was backed up to cloud'
          type: string
      title: SdkCloudBackupInfo has information about a backup stored by a cloud provider
      type: object
    apiSdkCloudBackupGroupCreateResponse:
      properties:
        group_cloud_backup_id:
          title: ID for this group of backups
          type: string
        task_ids:
          items:
            type: string
          title: TaskIds of the tasks performing the group backup
          type: array
      title: Empty response
      type: object
    Sharedv4ServiceSpecServiceType:
      default: UNSPECIFIED
      description: "Type of sharedv4 service. Values are governed by the different types\nof services supported by container orchestrators such as Kubernetes.\n\n - UNSPECIFIED: Unspecified\n - NODEPORT: Export the sharedv4 service on each Node's IP.\nIn this mode the sharedv4 volume can be accessed from outside the\ncluster using one of the node's IPs.\n - CLUSTERIP: Export the shared4 service on an internal cluster IP.\nIn this mode the sharedv4 volume will only be accessible\nwithin the cluster via this service.\n - LOADBALANCER: Expose the sharedv4 service on cloud provider's load balancer.\nApplicable when running in cloud. In this mode the sharedv4 volume\ncan be accessed from outside the cluster.\n - NONE: Do not use sharedv4 service feature. Use legacy sharedv4 volumes instead."
      enum:
      - UNSPECIFIED
      - NODEPORT
      - CLUSTERIP
      - LOADBALANCER
      - NONE
      type: string
    apiSdkCloudBackupSchedCreateRequest:
      properties:
        cloud_sched_info:
          $ref: '#/components/schemas/apiSdkCloudBackupScheduleInfo'
      title: 'Defines a request to create a schedule for volume backups to a

        cloud provider'
      type: object
    apiSdkCloudBackupSchedDeleteResponse:
      title: Empty response
      type: object
    apiReplicaSet:
      properties:
        id:
          format: int64
          title: ID is the unique ID of this replica set
          type: integer
        nodes:
          items:
            type: string
          type: array
        pool_uuids:
          items:
            type: string
          title: Unique IDs of the storage pools for this replica set
          type: array
      title: 'ReplicaSet set of machine IDs (nodes) to which part of this volume is erasure

        coded - for clustered storage arrays'
      type: object
    apiSdkCloudBackupRestoreResponse:
      properties:
        restore_volume_id:
          title: VolumeID to which the backup is being restored
          type: string
        task_id:
          title: TaskId of the task performing the restore
          type: string
      title: 'Defines a response when restoring a volume from a backup stored by

        a cloud provider'
      type: object
    apiSdkCloudBackupOpType:
      default: SdkCloudBackupOpTypeUnknown
      description: "- SdkCloudBackupOpTypeUnknown: Unknown\n - SdkCloudBackupOpTypeBackupOp: Backup\n - SdkCloudBackupOpTypeRestoreOp: Restore\n - SdkNearSyncOpTypeCloneOp: NearSync clone\n - SdkNearSyncOpTypeReplAddOp: NearSync replication add\n - SdkNearSyncOpTypeRestoreOp: NearSync restore"
      enum:
      - SdkCloudBackupOpTypeUnknown
      - SdkCloudBackupOpTypeBackupOp
      - SdkCloudBackupOpTypeRestoreOp
      - SdkNearSyncOpTypeCloneOp
      - SdkNearSyncOpTypeReplAddOp
      - SdkNearSyncOpTypeRestoreOp
      title: CloudBackup operations types
      type: string
    apiSdkCloudBackupCatalogResponse:
      properties:
        contents:
          items:
            type: string
          title: Contents is listing of backup contents
          type: array
      title: Defines a response containing the contents of a backup stored by a cloud provider
      type: object
    apiNFSProxySpec:
      description: NFSProxySpec is the spec for proxying an NFS share.
      properties:
        export_path:
          title: ExportPath is the NFS export path on the NFS server
          type: string
        sub_path:
          description: SubPath is the sub-directory from an NFS share that should be reflected.
          type: string
      type: object
    apiSdkCloudBackupRequestedState:
      default: SdkCloudBackupRequestedStateUnknown
      description: "- SdkCloudBackupRequestedStateUnknown: Unknown state\n - SdkCloudBackupRequestedStatePause: Pause the backup or restore\n - SdkCloudBackupRequestedStateResume: Resume the backup or restore\n - SdkCloudBackupRequestedStateStop: Stop a backup or restore\n - SdkNearSyncRequestedStatePause: Pause the near sync migrate\n - SdkNearSyncRequestedStateResume: Resume the near sync migrate\n - SdkNearSyncRequestedStateStop: Stop a near sync migrate"
      enum:
      - SdkCloudBackupRequestedStateUnknown
      - SdkCloudBackupRequestedStatePause
      - SdkCloudBackupRequestedStateResume
      - SdkCloudBackupRequestedStateStop
      - SdkNearSyncRequestedStatePause
      - SdkNearSyncRequestedStateResume
      - SdkNearSyncRequestedStateStop
      title: 'SdkCloudBackupRequestedState defines states to set a specified backup or restore

        to or from a cloud provider'
      type: string
    apiSdkCloudBackupClusterType:
      default: SdkCloudBackupClusterUnknown
      description: "- SdkCloudBackupClusterUnknown: Unknown\n - SdkCloudBackupClusterCurrent: Beongs to this cluster\n - SdkCloudBackupClusterOther: not this. other cluster"
      enum:
      - SdkCloudBackupClusterUnknown
      - SdkCloudBackupClusterCurrent
      - SdkCloudBackupClusterOther
      title: CloudBackup operations types
      type: string
    apiSdkCloudBackupStatusType:
      default: SdkCloudBackupStatusTypeUnknown
      description: "- SdkCloudBackupStatusTypeUnknown: Unknown\n - SdkCloudBackupStatusTypeNotStarted: Not started\n - SdkCloudBackupStatusTypeDone: Done\n - SdkCloudBackupStatusTypeAborted: Aborted\n - SdkCloudBackupStatusTypePaused: Paused\n - SdkCloudBackupStatusTypeStopped: Stopped\n - SdkCloudBackupStatusTypeActive: Active\n - SdkCloudBackupStatusTypeFailed: Failed\n - SdkCloudBackupStatusTypeQueued: Queued\n - SdkCloudBackupStatusTypeInvalid: Invalid, used by enumerate, includes failed,\nstopped and aborted\n - SdkNearSyncStatusTypeNotStarted: Near sync\nNot started\n - SdkNearSyncStatusTypeDone: Done\n - SdkNearSyncStatusTypePaused: Paused\n - SdkNearSyncStatusTypeStopped: Stopped\n - SdkNearSyncStatusTypeActive: Active\n - SdkNearSyncStatusTypeFailed: Failed\n - SdkNearSyncStatusTypeInvalid: Invalid"
      enum:
      - SdkCloudBackupStatusTypeUnknown
      - SdkCloudBackupStatusTypeNotStarted
      - SdkCloudBackupStatusTypeDone
      - SdkCloudBackupStatusTypeAborted
      - SdkCloudBackupStatusTypePaused
      - SdkCloudBackupStatusTypeStopped
      - SdkCloudBackupStatusTypeActive
      - SdkCloudBackupStatusTypeFailed
      - SdkCloudBackupStatusTypeQueued
      - SdkCloudBackupStatusTypeInvalid
      - SdkNearSyncStatusTypeNotStarted
      - SdkNearSyncStatusTypeDone
      - SdkNearSyncStatusTypePaused
      - SdkNearSyncStatusTypeStopped
      - SdkNearSyncStatusTypeActive
      - SdkNearSyncStatusTypeFailed
      - SdkNearSyncStatusTypeInvalid
      title: CloudBackup status types
      type: string
    apiProxyProtocol:
      default: PROXY_PROTOCOL_INVALID
      description: "ProxyProtocol defines the protocol used for proxy.\n\n - PROXY_PROTOCOL_INVALID: Invalid uninitialized value\n - PROXY_PROTOCOL_NFS: NFS indicates that the external data source is NFS and the volume\nwill be reflected over NFS protocol\n - PROXY_PROTOCOL_S3: S3 indicates that the external data source is an object store.\n - PROXY_PROTOCOL_PXD: PXD indicates that the external data source is a Portworx block volume.\n - PROXY_PROTOCOL_PURE_BLOCK: PURE_BLOCK indicates that the external data source is a pure_block volume.\n - PROXY_PROTOCOL_PURE_FILE: PURE_FILE indicates that the external data source is a pure_file volume."
      enum:
      - PROXY_PROTOCOL_INVALID
      - PROXY_PROTOCOL_NFS
      - PROXY_PROTOCOL_S3
      - PROXY_PROTOCOL_PXD
      - PROXY_PROTOCOL_PURE_BLOCK
      - PROXY_PROTOCOL_PURE_FILE
      type: string
    apiSdkCloudBackupCreateResponse:
      properties:
        task_id:
          title: TaskId of the task performing the backup
          type: string
      title: Empty response
      type: object
    apiVolumeLocator:
      description: 'VolumeLocator is a str

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