swagger: '2.0'
info:
  description: Configuration for backup resource.
  version: 'v2'
  title: backup
host: 'adm.cloud.com'
schemes:
 - https
# tags are used for organizing operations
tags:
  - name: backup
    description: backup
consumes:
  - application/json
produces:
  - application/json
securityDefinitions:
  UserSecurity:
    type: basic
security:
  - UserSecurity: []
parameters:
  authParam:
      in: header
      name: Authorization
      type: string
      required: true
      description: Session Id for authentication.Should be mentioned in the format CwsAuth bearer=sessionIdValue
  cloudParam:
      in: header
      name: isCloud
      type: string
      required: true
      description: set the value to true in case of Cloud services, false for on-prem deployment
paths:
  /massvc/{customerid}/nitro/v2/config/backup:
    get:
      tags:
        - backup
      summary: GET all backup
      operationId: getall_backup
      description: Use this operation to get backup component information
      consumes:
        - application/json
      produces:
        - application/json
      parameters:
        - in: path
          name: customerid
          type: string
          required: true
          description: Customer Id of the user
        - in: header
          name: Authorization
          type: string
          required: true
          description: Session Id for authentication.Should be mentioned in the format CwsAuth bearer=sessionIdValue
        - in: header
          name: isCloud
          type: string
          required: true
          description: set the value to true in case of Cloud services, false for on-prem deployment
        - in: query
          name: filter
          type: string
          required: false
          description: "Use this query-parameter to get the filtered set of vm_device resources configured on the system. You can set a filter on any property of the resource.Example:  property-name1:property-value1 "
        - in: query
          name: pagesize
          type: integer
          required: false
          description: Use this query-parameter to get the backup resources in chunks.To be used along with pageno query parameter.
        - in: query
          name: pageno
          type: integer
          required: false
          description: Use this query-parameter to get the backup resources in chunks.To be used along with pagesize query parameter.
        - in: query
          name: count
          type: string
          required: false
          description: Use this query-parameter to get the count of backup resources.
          enum:
            - yes
      responses:
        200:
          description:  for backup
          schema: 
              $ref: '#/definitions/getbackupsResponse'
        400:
          description: Bad input parameter
          schema: 
              $ref: '#/definitions/Error'
        401:
          description: Failed Authentication
          schema: 
              $ref: '#/definitions/Error'
        403:
          description: Unauthorized
          schema: 
              $ref: '#/definitions/Error'
        404:
          description: Item not found
          schema: 
              $ref: '#/definitions/Error'
        409:
          description: Resource Conflict
          schema: 
              $ref: '#/definitions/Error'
        500:
          description: Server Error
          schema: 
              $ref: '#/definitions/Error'
        504:
          description: Gateway Timeout
          schema: 
              $ref: '#/definitions/Error'

    post:
      tags:
        - backup
      summary: POST operation for backup
      operationId: post_backup
      description: POST operation for backup
      consumes:
        - application/json
      produces:
        - application/json
      parameters:
        - in: path
          name: customerid
          type: string
          required: true
          description: Customer Id of the user
        - in: header
          name: Authorization
          type: string
          required: true
          description: Session Id for authentication.Should be mentioned in the format CwsAuth bearer=sessionIdValue
        - in: header
          name: isCloud
          type: string
          required: true
          description: set the value to true in case of Cloud services, false for on-prem deployment
        - in: query
          name: onerror
          description: Use this parameter to set the onerror status for nitro request. Applicable only for bulk requests.
          required: false
          type: string
          default: CONTINUE
          enum:
            - EXIT
            - CONTINUE
        - in: body
          name: backup
          description: backup object
          schema:
              $ref: '#/definitions/addbackupRequest'
      responses:
        200:
          description: add for backup
          schema: 
              $ref: '#/definitions/addbackupResponse'
        400:
          description: Bad input parameter
          schema: 
              $ref: '#/definitions/Error'
        401:
          description: Failed Authentication
          schema: 
              $ref: '#/definitions/Error'
        403:
          description: Unauthorized
          schema: 
              $ref: '#/definitions/Error'
        404:
          description: Item not found
          schema: 
              $ref: '#/definitions/Error'
        409:
          description: Resource Conflict
          schema: 
              $ref: '#/definitions/Error'
        500:
          description: Server Error
          schema: 
              $ref: '#/definitions/Error'
        504:
          description: Gateway Timeout
          schema: 
              $ref: '#/definitions/Error'

definitions:
  addbackupRequest:
    type: object
    required:
      - backup
    properties:
      backup:
        $ref: '#/definitions/backup_readwrite'
    title: addbackupRequest
    example:
      backup:
        backup_file_name: "string_value"
        backup_password: "string_value"

  addbackupResponse:
    type: object
    required:
      - backup
    properties:
      backup:
        $ref: '#/definitions/backup'
    title: addbackupResponse
    example:
      backup:
        backup_file_name: "string_value"
        backup_password: "string_value"

  getbackupResponse:
    type: object
    required:
      - backup
    properties:
      backup:
        $ref: '#/definitions/backup'
    title: getbackupResponse
    example:
      backup:
        backup_file_name: "string_value"
        backup_password: "string_value"

  getbackupsResponse:
    type: object
    required:
      - backup
    properties:
      backup:
        type: array
        items:
          $ref: '#/definitions/backup'
    title: getbackupsResponse
    example:
      backup:
        backup_file_name: "string_value"
        backup_password: "string_value"

  backup_readwrite:
    type: object
    properties:
      backup_file_name:
        description: "Backup file name"
        type: string
        format: string
        maxLength: 64
      backup_password:
        description: "Password of encrypted backup file"
        type: string
        format: password

  backup:
    allOf:
      - $ref: '#/definitions/backup_readwrite'

  Error:
    properties:
      errorcode:
        type: number
        format: int32
        example: 1001
      errormessage:
        type: string
        format: string
        example: "id cannot be found"
