SimpliVity

SimpliVity backups API

A backup is a complete, standalone image of a specific virtual machine, taken at a specific point in time.

GitHub OpenAPI

Documentation

📖
Authentication
https://raw.githubusercontent.com/api-evangelist/simplivity/refs/heads/main/authentication/simplivity-authentication.yml

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/simplivity/refs/heads/main/openapi/simplivity-backups-api-openapi.yml

Other Resources

🔗
OAuthScopes
https://raw.githubusercontent.com/api-evangelist/simplivity/refs/heads/main/scopes/simplivity-scopes.yml
🔗
APIsJSON
https://raw.githubusercontent.com/api-evangelist/simplivity/refs/heads/main/apis.yml

OpenAPI Specification

simplivity-backups-api-openapi.yml Raw ↑ 
swagger: '2.0'
info:
  description: "This API enables the programmatic management of key components of an HPE SimpliVity configuration.\n\nTo access the API, request an authentication token by issuing an authentication request in the following form, where the username/password combination is a set of valid management credentials for the applicable hypervisor environment:\n\n     curl -k https://simplivity@<host>/api/oauth/token -d grant_type=password -d username=<user> -d password=<pass>\n\nThen, you can pass in the resulting access_token returned in each HTTP header using Authorization: Bearer token. For example:\n\n     curl -H \"Authorization: Bearer 0a08c809-17ff-479f-b0a8-aedd4d8305a0\"\n\nThe access_token times out after 10 minutes of inactivity and expires after 24 hours.\n\nMake sure to use TLS version 1.2 or greater.\n\nThere are a wide range of possible return values.  Below is a list of the most common return values. \n\n    200 \"OK\" ⁃ This indicates that the request and action has completed with no issues.\n    201 \"Created\" ⁃ This indicates that the request has completed and a new resource has been created.\n    202 \"Accepted\" ⁃ This indicates that the request has been accepted for processing but the processing has not\n                     completed. This is a typical return when a task is generated.\n    400 \"Bad Request\" ⁃ The request cannot or will not be proccessed.  Usually due to a missing required parameter\n                        or invalid data in the parameter.\n    401 \"Unauthorized\" ⁃ The request has not been applied because it lacks authentication credentials for the\n                         target resource.\n    404 \"Not Found\" ⁃ The requested target doesn't exist or has been deleted.\n    405 \"Method Not Allowed\" ⁃ The method being requested is not valid for the target it is being performed on.\n    408 \"Request Timeout\" ⁃ The response took too long.\n    500 \"Internal Server Error\" ⁃ Indicates that the server encountered an unexpected condition that prevented it\n                                  from fulfilling the request.\n\n<a href=\"https://developer.hpe.com/platform/hpe-simplivity/home\" class=\"\toggleEndpointList\" data-id=\"errors\">Click here for a complete list of return codes and response formats</a>\n\n"
  version: '1.25'
  title: HPE OmniStack REST backups API
  contact:
    name: Hewlett Packard Enterprise
  license:
    name: HPE OmniStack REST API
host: localhost
basePath: ''
tags:
- name: backups
  description: A backup is a complete, standalone image of a specific virtual machine, taken at a specific point in time.
paths:
  /backups:
    get:
      tags:
      - backups
      summary: Retrieves all backups defined on this system
      operationId: listBackups
      consumes:
      - application/json
      produces:
      - application/vnd.simplivity.v1.23+json
      - application/vnd.simplivity.v1.9+json
      - application/vnd.simplivity.v1.18+json
      - application/vnd.simplivity.v1.14+json
      - application/vnd.simplivity.v1.11+json
      - application/vnd.simplivity.v1.17+json
      - application/vnd.simplivity.v1.21+json
      - application/vnd.simplivity.v1.22+json
      - application/vnd.simplivity.v1.3+json
      - application/vnd.simplivity.v1.10+json
      - application/vnd.simplivity.v1.6+json
      - application/vnd.simplivity.v1.25+json
      - application/vnd.simplivity.v1.19+json
      - application/json
      - application/vnd.simplivity.v1.5+json
      - application/vnd.simplivity.v1.13+json
      - application/vnd.simplivity.v1.16+json
      - application/vnd.simplivity.v1.2+json
      - application/vnd.simplivity.v1.24+json
      - application/vnd.simplivity.v1.7+json
      - application/vnd.simplivity.v1.4+json
      - application/vnd.simplivity.v1.1+json
      - application/vnd.simplivity.v1+json
      - application/vnd.simplivity.v1.8+json
      - application/vnd.simplivity.v1.15+json
      - application/vnd.simplivity.v1.12+json
      - application/vnd.simplivity.v1.20+json
      parameters:
      - name: id
        in: query
        description: 'the unique identifier (UID) of the backups to return


          Accepts: Single value, comma-separated list'
        required: false
        type: string
      - name: name
        in: query
        description: 'The name of the backups to return


          Accepts: Single value, comma-separated list, pattern using one or more asterisk characters as a wildcard'
        required: false
        type: string
      - name: sent_min
        in: query
        description: The minimum sent data size (in bytes) of the remote backups to return
        required: false
        type: integer
        format: int64
      - name: sent_max
        in: query
        description: The maximum sent data size (in bytes) of the remote backups to return
        required: false
        type: integer
        format: int64
      - name: state
        in: query
        description: 'The current state of the backups to return


          Accepts: Single value, comma-separated list'
        required: false
        type: string
      - name: type
        in: query
        description: 'The type of backups to return


          Accepts: Single value, comma-separated list'
        required: false
        type: string
      - name: omnistack_cluster_id
        in: query
        description: 'The unique identifier (UID) of the omnistack_cluster that is associated with the instances to return


          Accepts: Single value, comma-separated list'
        required: false
        type: string
      - name: omnistack_cluster_name
        in: query
        description: 'The name of the omnistack_cluster that is associated with the instances to return


          Accepts: Single value, comma-separated list'
        required: false
        type: string
      - name: compute_cluster_parent_hypervisor_object_id
        in: query
        description: 'The unique identifier (UID) of the hypervisor-based instance that contains the omnistack_cluster that is associated with the instances to return


          Accepts: Single value, comma-separated list'
        required: false
        type: string
      - name: compute_cluster_parent_name
        in: query
        description: 'The name of the hypervisor-based instance that contains the omnistack_cluster that is associated with the instances to return


          Accepts: Single value, comma-separated list'
        required: false
        type: string
      - name: datastore_id
        in: query
        description: 'The unique identifier (UID) of the datastore that is associated with the instances to return


          Accepts: Single value, comma-separated list'
        required: false
        type: string
      - name: datastore_name
        in: query
        description: 'The name of the datastore that is associated with the instances to return


          Accepts: Single value, comma-separated list'
        required: false
        type: string
      - name: expires_before
        in: query
        description: The latest expiration time before the backups to return expire, expressed in ISO-8601 form, based on Coordinated Universal Time (UTC)
        required: false
        type: string
      - name: expires_after
        in: query
        description: The earliest expiration time after the backups to return expire, expressed in ISO-8601 form, based on Coordinated Universal Time (UTC)
        required: false
        type: string
      - name: virtual_machine_id
        in: query
        description: 'The unique identifier (UID) of the virtual_machine that is associated with the instances to return


          Accepts: Single value, comma-separated list'
        required: false
        type: string
      - name: virtual_machine_name
        in: query
        description: 'The name of the virtual_machine that is associated with the instances to return


          Accepts: Single value, comma-separated list'
        required: false
        type: string
      - name: virtual_machine_type
        in: query
        description: 'The type of the virtual_machine that is associated with the instances to return


          Accepts: Single value, comma-separated list'
        required: false
        type: string
      - name: virtual_machine_state
        in: query
        description: 'The state of the virtual_machine that is associated with the instances to return


          Accepts: Single value, comma-separated list'
        required: false
        type: string
      - name: size_min
        in: query
        description: The minimum size (in bytes) of the backups to return
        required: false
        type: integer
        format: int64
      - name: size_max
        in: query
        description: The maximum size (in bytes) of the backups to return
        required: false
        type: integer
        format: int64
      - name: application_consistent
        in: query
        description: The application-consistent setting of the backups to return
        required: false
        type: boolean
      - name: consistency_type
        in: query
        description: 'The consistency type of the backups to return


          Accepts: Single value, comma-separated list'
        required: false
        type: string
      - name: created_before
        in: query
        description: The latest creation time before the backups to return were created, expressed in ISO-8601 form, based on Coordinated Universal Time (UTC)
        required: false
        type: string
      - name: created_after
        in: query
        description: The earliest creation time after the backups to return were created, expressed in ISO-8601 form, based on Coordinated Universal Time (UTC)
        required: false
        type: string
      - name: sent_duration_min
        in: query
        description: The minimum number of seconds that elapsed while replicating the backups to return
        required: false
        type: integer
        format: int64
      - name: sent_duration_max
        in: query
        description: The maximum number of seconds that elapsed while replicating the backups to return
        required: false
        type: integer
        format: int64
      - name: sent_completion_before
        in: query
        description: The latest time before the replication of backups to return was completed, expressed in ISO-8601 form, based on Coordinated Universal Time (UTC)
        required: false
        type: string
      - name: sent_completion_after
        in: query
        description: The earliest time after the replication of backups to return was completed, expressed in ISO-8601 form, based on Coordinated Universal Time (UTC)
        required: false
        type: string
      - name: unique_size_bytes_min
        in: query
        description: The minimum unique size (in bytes) of the backups to return
        required: false
        type: integer
        format: int64
      - name: unique_size_bytes_max
        in: query
        description: The maximum unique size (in bytes) of the backups to return
        required: false
        type: integer
        format: int64
      - name: cluster_group_id
        in: query
        description: 'The unique identifiers (UIDs) of the cluster_groups associated with the backups to return


          Accepts: Single value, comma-separated list'
        required: false
        type: string
      - name: external_store_name
        in: query
        description: 'The name of the external_stores to return


          Accepts: Single value, comma-separated list, pattern using one or more asterisk characters as a wildcard'
        required: false
        type: string
      - name: backup_store_type
        in: query
        description: 'The storage type of the backups to return


          Accepts: Single value, comma-separated list'
        required: false
        type: string
      - name: associated_cluster
        in: query
        description: 'The cluster associated with the external_stores to return


          Accepts: Single value, comma-separated list'
        required: false
        type: string
      - name: fields
        in: query
        description: "A comma-separated list of fields to include in the returned objects\n\n Default: Returns all fields"
        required: false
        type: string
      - name: limit
        in: query
        description: 'A positive integer that represents the maximum number of results to return


          Default: 500'
        required: false
        type: integer
        default: 500
        format: int32
      - name: offset
        in: query
        description: 'A positive integer that directs the service to start returning the &lt;offset value&gt; instance, up to the limit


          Default: 0'
        required: false
        type: integer
        default: 0
        format: int32
      - name: case
        in: query
        description: 'An indicator that specifies if the filter and sort results use a case-sensitive or insensitive manner


          Valid values: sensitive or insensitive


          Default: sensitive'
        required: false
        type: string
        default: sensitive
        enum:
        - sensitive
        - insensitive
      - name: sort
        in: query
        description: The name of the field where the sort occurs
        required: false
        type: string
      - name: order
        in: query
        description: 'The sort order preference


          Valid values: ascending or descending


          Default: descending'
        required: false
        type: string
      responses:
        '200':
          description: OK
          schema:
            $ref: '#/definitions/BackupMO'
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
        '404':
          description: Not Found
  /backups/delete:
    post:
      tags:
      - backups
      summary: Deletes the specified list of backup instances
      operationId: deleteBackups
      consumes:
      - application/vnd.simplivity.v1.23+json
      - application/vnd.simplivity.v1.9+json
      - application/vnd.simplivity.v1.18+json
      - application/vnd.simplivity.v1.14+json
      - application/vnd.simplivity.v1.11+json
      - application/vnd.simplivity.v1.17+json
      - application/vnd.simplivity.v1.21+json
      - application/vnd.simplivity.v1.22+json
      - application/vnd.simplivity.v1.3+json
      - application/vnd.simplivity.v1.10+json
      - application/vnd.simplivity.v1.6+json
      - application/vnd.simplivity.v1.25+json
      - application/vnd.simplivity.v1.19+json
      - application/vnd.simplivity.v1.5+json
      - application/vnd.simplivity.v1.13+json
      - application/vnd.simplivity.v1.16+json
      - application/vnd.simplivity.v1.2+json
      - application/vnd.simplivity.v1.24+json
      - application/vnd.simplivity.v1.7+json
      - application/vnd.simplivity.v1.4+json
      - application/vnd.simplivity.v1.1+json
      - application/vnd.simplivity.v1+json
      - application/vnd.simplivity.v1.8+json
      - application/vnd.simplivity.v1.15+json
      - application/vnd.simplivity.v1.12+json
      - application/vnd.simplivity.v1.20+json
      produces:
      - application/vnd.simplivity.v1.23+json
      - application/vnd.simplivity.v1.9+json
      - application/vnd.simplivity.v1.18+json
      - application/vnd.simplivity.v1.14+json
      - application/vnd.simplivity.v1.11+json
      - application/vnd.simplivity.v1.17+json
      - application/vnd.simplivity.v1.21+json
      - application/vnd.simplivity.v1.22+json
      - application/vnd.simplivity.v1.3+json
      - application/vnd.simplivity.v1.10+json
      - application/vnd.simplivity.v1.6+json
      - application/vnd.simplivity.v1.25+json
      - application/vnd.simplivity.v1.19+json
      - application/json
      - application/vnd.simplivity.v1.5+json
      - application/vnd.simplivity.v1.13+json
      - application/vnd.simplivity.v1.16+json
      - application/vnd.simplivity.v1.2+json
      - application/vnd.simplivity.v1.24+json
      - application/vnd.simplivity.v1.7+json
      - application/vnd.simplivity.v1.4+json
      - application/vnd.simplivity.v1.1+json
      - application/vnd.simplivity.v1+json
      - application/vnd.simplivity.v1.8+json
      - application/vnd.simplivity.v1.15+json
      - application/vnd.simplivity.v1.12+json
      - application/vnd.simplivity.v1.20+json
      parameters:
      - in: body
        name: backups deletion information
        description: 'backup_id: The list of the unique identifier (UID) of the backups that you want to delete'
        required: true
        schema:
          $ref: '#/definitions/delete_backups'
      responses:
        '200':
          description: OK
          schema:
            $ref: '#/definitions/TaskMO'
        '201':
          description: Created
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
        '404':
          description: Not Found
  /backups/set_retention:
    post:
      tags:
      - backups
      summary: Sets the retention time for the specified list of backups
      operationId: setBackupRetention
      consumes:
      - application/vnd.simplivity.v1.23+json
      - application/vnd.simplivity.v1.9+json
      - application/vnd.simplivity.v1.18+json
      - application/vnd.simplivity.v1.14+json
      - application/vnd.simplivity.v1.11+json
      - application/vnd.simplivity.v1.17+json
      - application/vnd.simplivity.v1.21+json
      - application/vnd.simplivity.v1.22+json
      - application/vnd.simplivity.v1.3+json
      - application/vnd.simplivity.v1.10+json
      - application/vnd.simplivity.v1.6+json
      - application/vnd.simplivity.v1.25+json
      - application/vnd.simplivity.v1.19+json
      - application/vnd.simplivity.v1.5+json
      - application/vnd.simplivity.v1.13+json
      - application/vnd.simplivity.v1.16+json
      - application/vnd.simplivity.v1.2+json
      - application/vnd.simplivity.v1.24+json
      - application/vnd.simplivity.v1.7+json
      - application/vnd.simplivity.v1.4+json
      - application/vnd.simplivity.v1.1+json
      - application/vnd.simplivity.v1+json
      - application/vnd.simplivity.v1.8+json
      - application/vnd.simplivity.v1.15+json
      - application/vnd.simplivity.v1.12+json
      - application/vnd.simplivity.v1.20+json
      produces:
      - application/vnd.simplivity.v1.23+json
      - application/vnd.simplivity.v1.9+json
      - application/vnd.simplivity.v1.18+json
      - application/vnd.simplivity.v1.14+json
      - application/vnd.simplivity.v1.11+json
      - application/vnd.simplivity.v1.17+json
      - application/vnd.simplivity.v1.21+json
      - application/vnd.simplivity.v1.22+json
      - application/vnd.simplivity.v1.3+json
      - application/vnd.simplivity.v1.10+json
      - application/vnd.simplivity.v1.6+json
      - application/vnd.simplivity.v1.25+json
      - application/vnd.simplivity.v1.19+json
      - application/json
      - application/vnd.simplivity.v1.5+json
      - application/vnd.simplivity.v1.13+json
      - application/vnd.simplivity.v1.16+json
      - application/vnd.simplivity.v1.2+json
      - application/vnd.simplivity.v1.24+json
      - application/vnd.simplivity.v1.7+json
      - application/vnd.simplivity.v1.4+json
      - application/vnd.simplivity.v1.1+json
      - application/vnd.simplivity.v1+json
      - application/vnd.simplivity.v1.8+json
      - application/vnd.simplivity.v1.15+json
      - application/vnd.simplivity.v1.12+json
      - application/vnd.simplivity.v1.20+json
      parameters:
      - in: body
        name: backups retention information
        description: "backup_id: The list of the unique identifier (UID) of the backups that you want to set the retention time for\n\nforce: An indicator to force a retention time modification even if this action results in deleting backups\n\nValid values:\n\nTrue: Sets the new retention time for the specified list of backups. This action may delete of one or more backups.\n\nFalse: Does not make the requested retention time modification if this results in deleting one or more backups. This operation returns a list of backups that the requested modification deletes. If the requested modification does not delete the backups, the retention time modification occurs.\n\nDefault: false\n\nretention: The number of minutes to keep backups\n\nforever: Retains backups indefinitely \n\nValid values:\n\nTrue: Sets the backup retention time to never expire.\n\nFalse: Sets the backup retention time according to the specified \"retention\".\n\nDefault: false"
        required: true
        schema:
          $ref: '#/definitions/backup_retention_set'
      responses:
        '200':
          description: OK
          schema:
            $ref: '#/definitions/BackupMO'
        '201':
          description: Created
        '202':
          description: Accepted
          schema:
            $ref: '#/definitions/TaskMO'
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
        '404':
          description: Not Found
  /backups/{bkpId}:
    get:
      tags:
      - backups
      summary: Retrieves the specified backup
      operationId: getBackup
      consumes:
      - application/json
      produces:
      - application/vnd.simplivity.v1.23+json
      - application/vnd.simplivity.v1.9+json
      - application/vnd.simplivity.v1.18+json
      - application/vnd.simplivity.v1.14+json
      - application/vnd.simplivity.v1.11+json
      - application/vnd.simplivity.v1.17+json
      - application/vnd.simplivity.v1.21+json
      - application/vnd.simplivity.v1.22+json
      - application/vnd.simplivity.v1.3+json
      - application/vnd.simplivity.v1.10+json
      - application/vnd.simplivity.v1.6+json
      - application/vnd.simplivity.v1.25+json
      - application/vnd.simplivity.v1.19+json
      - application/json
      - application/vnd.simplivity.v1.5+json
      - application/vnd.simplivity.v1.13+json
      - application/vnd.simplivity.v1.16+json
      - application/vnd.simplivity.v1.2+json
      - application/vnd.simplivity.v1.24+json
      - application/vnd.simplivity.v1.7+json
      - application/vnd.simplivity.v1.4+json
      - application/vnd.simplivity.v1.1+json
      - application/vnd.simplivity.v1+json
      - application/vnd.simplivity.v1.8+json
      - application/vnd.simplivity.v1.15+json
      - application/vnd.simplivity.v1.12+json
      - application/vnd.simplivity.v1.20+json
      parameters:
      - name: bkpId
        in: path
        description: The unique identifier (UID) of the backup that you want to retrieve
        required: true
        type: string
      responses:
        '200':
          description: OK
          schema:
            $ref: '#/definitions/BackupMO'
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
        '404':
          description: Not Found
    delete:
      tags:
      - backups
      summary: Deletes the specified backup
      operationId: deleteBackup
      consumes:
      - application/json
      produces:
      - application/vnd.simplivity.v1.23+json
      - application/vnd.simplivity.v1.9+json
      - application/vnd.simplivity.v1.18+json
      - application/vnd.simplivity.v1.14+json
      - application/vnd.simplivity.v1.11+json
      - application/vnd.simplivity.v1.17+json
      - application/vnd.simplivity.v1.21+json
      - application/vnd.simplivity.v1.22+json
      - application/vnd.simplivity.v1.3+json
      - application/vnd.simplivity.v1.10+json
      - application/vnd.simplivity.v1.6+json
      - application/vnd.simplivity.v1.25+json
      - application/vnd.simplivity.v1.19+json
      - application/json
      - application/vnd.simplivity.v1.5+json
      - application/vnd.simplivity.v1.13+json
      - application/vnd.simplivity.v1.16+json
      - application/vnd.simplivity.v1.2+json
      - application/vnd.simplivity.v1.24+json
      - application/vnd.simplivity.v1.7+json
      - application/vnd.simplivity.v1.4+json
      - application/vnd.simplivity.v1.1+json
      - application/vnd.simplivity.v1+json
      - application/vnd.simplivity.v1.8+json
      - application/vnd.simplivity.v1.15+json
      - application/vnd.simplivity.v1.12+json
      - application/vnd.simplivity.v1.20+json
      parameters:
      - name: bkpId
        in: path
        description: The unique identifier (UID) of the backup that you want to retrieve
        required: true
        type: string
      responses:
        '200':
          description: OK
          schema:
            $ref: '#/definitions/TaskMO'
        '204':
          description: No Content
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
  /backups/{bkpId}/calculate_unique_size:
    post:
      tags:
      - backups
      summary: Calculates the unique size of the specified backup
      operationId: calculateUniqueSize
      consumes:
      - application/vnd.simplivity.v1.23+json
      - application/vnd.simplivity.v1.9+json
      - application/vnd.simplivity.v1.18+json
      - application/vnd.simplivity.v1.14+json
      - application/vnd.simplivity.v1.11+json
      - application/vnd.simplivity.v1.17+json
      - application/vnd.simplivity.v1.21+json
      - application/vnd.simplivity.v1.22+json
      - application/vnd.simplivity.v1.3+json
      - application/vnd.simplivity.v1.10+json
      - application/vnd.simplivity.v1.6+json
      - application/vnd.simplivity.v1.25+json
      - application/vnd.simplivity.v1.19+json
      - application/vnd.simplivity.v1.5+json
      - application/vnd.simplivity.v1.13+json
      - application/vnd.simplivity.v1.16+json
      - application/vnd.simplivity.v1.2+json
      - application/vnd.simplivity.v1.24+json
      - application/vnd.simplivity.v1.7+json
      - application/vnd.simplivity.v1.4+json
      - application/vnd.simplivity.v1.1+json
      - application/vnd.simplivity.v1+json
      - application/vnd.simplivity.v1.8+json
      - application/vnd.simplivity.v1.15+json
      - application/vnd.simplivity.v1.12+json
      - application/vnd.simplivity.v1.20+json
      produces:
      - application/vnd.simplivity.v1.23+json
      - application/vnd.simplivity.v1.9+json
      - application/vnd.simplivity.v1.18+json
      - application/vnd.simplivity.v1.14+json
      - application/vnd.simplivity.v1.11+json
      - application/vnd.simplivity.v1.17+json
      - application/vnd.simplivity.v1.21+json
      - application/vnd.simplivity.v1.22+json
      - application/vnd.simplivity.v1.3+json
      - application/vnd.simplivity.v1.10+json
      - application/vnd.simplivity.v1.6+json
      - application/vnd.simplivity.v1.25+json
      - application/vnd.simplivity.v1.19+json
      - application/json
      - application/vnd.simplivity.v1.5+json
      - application/vnd.simplivity.v1.13+json
      - application/vnd.simplivity.v1.16+json
      - application/vnd.simplivity.v1.2+json
      - application/vnd.simplivity.v1.24+json
      - application/vnd.simplivity.v1.7+json
      - application/vnd.simplivity.v1.4+json
      - application/vnd.simplivity.v1.1+json
      - application/vnd.simplivity.v1+json
      - application/vnd.simplivity.v1.8+json
      - application/vnd.simplivity.v1.15+json
      - application/vnd.simplivity.v1.12+json
      - application/vnd.simplivity.v1.20+json
      parameters:
      - name: bkpId
        in: path
        description: The unique identifier (UID) of the backup that you want to perform the calculation on
        required: true
        type: string
      responses:
        '200':
          description: OK
          schema:
            $ref: '#/definitions/TaskMO'
        '201':
          description: Created
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
        '404':
          description: Not Found
  /backups/{bkpId}/cancel:
    post:
      tags:
      - backups
      summary: Cancels the specified running backup
      operationId: cancelBackup
      consumes:
      - application/vnd.simplivity.v1.23+json
      - application/vnd.simplivity.v1.9+json
      - application/vnd.simplivity.v1.18+json
      - application/vnd.simplivity.v1.14+json
      - application/vnd.simplivity.v1.11+json
      - application/vnd.simplivity.v1.17+json
      - application/vnd.simplivity.v1.21+json
      - application/vnd.simplivity.v1.22+json
      - application/vnd.simplivity.v1.3+json
      - application/vnd.simplivity.v1.10+json
      - application/vnd.simplivity.v1.6+json
      - application/vnd.simplivity.v1.25+json
      - application/vnd.simplivity.v1.19+json
      - application/vnd.simplivity.v1.5+json
      - application/vnd.simplivity.v1.13+json
      - application/vnd.simplivity.v1.16+json
      - application/vnd.simplivity.v1.2+json
      - application/vnd.simplivity.v1.24+json
      - application/vnd.simplivity.v1.7+json
      - application/vnd.simplivity.v1.4+json
      - application/vnd.simplivity.v1.1+json
      - application/vnd.simplivity.v1+json
      - application/vnd.simplivity.v1.8+json
      - application/vnd.simplivity.v1.15+json
      - application/vnd.simplivity.v1.12+json
      - application/vnd.simplivity.v1.20+json
      produces:
      - application/vnd.simplivity.v1.23+json
      - application/vnd.simplivity.v1.9+json
      - application/vnd.simplivity.v1.18+json
      - application/vnd.simplivity.v1.14+json
      - application/vnd.simplivity.v1.11+json
      - application/vnd.simplivity.v1.17+json
      - application/vnd.simplivity.v1.21+json
      - application/vnd.simplivity.v1.22+json
      - application/vnd.simplivity.v1.3+json
      - application/vnd.simplivity.v1.10+json
      - application/vnd.simplivity.v1.6+json
      - application/vnd.simplivity.v1.25+json
      - application/vnd.simplivity.v1.19+json
      - application/json
      - application/vnd.simplivity.v1.5+json
      - application/vnd.simplivity.v1.13+json
      - application/vnd.simplivity.v1.16+json
      - application/vnd.simplivity.v1.2+json
      - application/vnd.simplivity.v1.24+json
      - application/vnd.simplivity.v1.7+json
      - application/vnd.simplivity.v1.4+json
      - application/vnd.simplivity.v1.1+json
      - application/vnd.simplivity.v1+json
      - application/vnd.simplivity.v1.8+json
      - application/vnd.simplivity.v1.15+json
      - application/vnd.simplivity.v1.12+json
      - application/vnd.simplivity.v1.20+json
      parameters:
      - name: bkpId
        in: path
        description: The unique identifier (UID) of the backup that you want to cancel
        required: true
        type: string
      responses:
        '200':
          description: OK
          schema:
            $ref: '#/definitions/TaskMO'
        '201':
          description: Created
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
        '404':
          description: Not Found
  /backups/{bkpId}/copy:
    post:
      tags:
      - backups
      summary: Copies the specified backup to another omnistack_cluster or external_store
      operationId: copyBackup
      consumes:
      - application/vnd.simplivity.v1.23+json
      - application/vnd.simplivity.v1.9+json
      - application/vnd.simplivity.v1.18+json
      - application/vnd.simplivity.v1.14+json
      - application/vnd.simplivity.v1.11+json
      - application/vnd.simplivity.v1.17+json
      - application/vnd.simplivity.v1.21+json
      - application/vnd.simplivity.v1.22+json
      - application/vnd.simplivity.v1.3+json
      - application/vnd.simplivity.v1.10+json
      - application/vnd.simplivity.v1.6+json
      - application/vnd.simplivity.v1.25+json
      - application/vnd.simplivity.v1.19+json
      - application/vnd.simplivity.v1.5+json
      - application/vnd.simplivity.v1.13+json
      - application/vnd.simplivity.v1.16+json
      - application/vnd.simplivity.v1.2+json
      - application/vnd.simplivity.v1.24+json
      - application/vnd.simplivity.v1.7+json
      - application/vnd.simplivity.v1.4+json
      - application/vnd.simplivity.v1.1+json
      - application/vnd.simplivity.v1+json
      - application/vnd.simplivity.v1.8+json
      - application/vnd.simplivity.v1.15+json
      - application/vnd.simplivity.v1.12+json
      - application/vnd.simplivity.v1.20+json
      produces:
      - application/vnd.simplivity.v1.23+json
      - application/vnd.simplivity.v1.9+json
      - application/vnd.simplivity.v1.18+json
      - application/vnd.simplivity.v1.14+json
      - application

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