Sybase Backups API

openapi: 3.1.0
info:
  title: Sybase ASE REST Backups API
  description: REST API for SAP Adaptive Server Enterprise (ASE) administration and monitoring. Provides programmatic access to server configuration, database management, performance monitoring, user administration, and backup operations for SAP ASE database instances. SAP ASE is a high-performance relational database management system designed for transaction-based enterprise applications.
  version: '16.0'
  contact:
    name: SAP Support
    url: https://support.sap.com/en/product/database.html
  termsOfService: https://www.sap.com/about/legal/terms-of-use.html
servers:
- url: https://{server}:{port}/ase/v1
  description: SAP ASE REST API Server
  variables:
    server:
      default: localhost
      description: SAP ASE server hostname
    port:
      default: '8443'
      description: HTTPS port for the REST API
security:
- basicAuth: []
- bearerAuth: []
tags:
- name: Backups
  description: Operations for managing database backup and recovery operations including scheduling and status monitoring.
paths:
  /servers/{serverId}/backups:
    get:
      operationId: listBackups
      summary: List Backup History
      description: Retrieves the backup history for the specified SAP ASE server including completed, in-progress, and scheduled backup operations.
      tags:
      - Backups
      parameters:
      - $ref: '#/components/parameters/serverId'
      - name: databaseName
        in: query
        description: Filter backup history by database name.
        required: false
        schema:
          type: string
      responses:
        '200':
          description: Successful retrieval of backup history
          content:
            application/json:
              schema:
                type: object
                properties:
                  backups:
                    type: array
                    items:
                      $ref: '#/components/schemas/Backup'
        '401':
          description: Authentication credentials are missing or invalid
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
    post:
      operationId: createBackup
      summary: Initiate a Database Backup
      description: Initiates a new backup operation for the specified database on the SAP ASE server. Supports full database dumps, transaction log dumps, and incremental backups.
      tags:
      - Backups
      parameters:
      - $ref: '#/components/parameters/serverId'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/BackupCreateRequest'
      responses:
        '202':
          description: Backup operation initiated successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Backup'
        '400':
          description: Invalid request parameters
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '401':
          description: Authentication credentials are missing or invalid
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
components:
  schemas:
    BackupCreateRequest:
      type: object
      description: Request body for initiating a database backup operation.
      required:
      - databaseName
      - type
      - deviceName
      properties:
        databaseName:
          type: string
          description: The name of the database to back up.
        type:
          type: string
          description: The type of backup to perform.
          enum:
          - full
          - transaction_log
          - incremental
        deviceName:
          type: string
          description: The backup device or file path to write to.
        compress:
          type: boolean
          description: Whether to compress the backup.
          default: false
    Error:
      type: object
      description: Standard error response returned when an API request fails.
      properties:
        code:
          type: string
          description: A machine-readable error code.
        message:
          type: string
          description: A human-readable error message.
        details:
          type: string
          description: Additional details about the error.
    Backup:
      type: object
      description: Represents a database backup operation on the SAP ASE server.
      properties:
        id:
          type: string
          description: Unique identifier for the backup operation.
        databaseName:
          type: string
          description: The name of the database that was backed up.
        type:
          type: string
          description: The type of backup operation.
          enum:
          - full
          - transaction_log
          - incremental
        status:
          type: string
          description: Current status of the backup operation.
          enum:
          - completed
          - in_progress
          - failed
          - scheduled
        startTime:
          type: string
          format: date-time
          description: Timestamp when the backup started.
        endTime:
          type: string
          format: date-time
          description: Timestamp when the backup completed.
        sizeMB:
          type: number
          format: double
          description: Size of the backup in megabytes.
        deviceName:
          type: string
          description: The backup device or file path used.
  parameters:
    serverId:
      name: serverId
      in: path
      required: true
      description: The unique identifier of the SAP ASE server instance.
      schema:
        type: string
  securitySchemes:
    basicAuth:
      type: http
      scheme: basic
      description: HTTP Basic authentication using SAP ASE server login credentials.
    bearerAuth:
      type: http
      scheme: bearer
      description: Bearer token authentication for API access.
externalDocs:
  description: SAP ASE Documentation
  url: https://help.sap.com/docs/SAP_ASE