Sybase

opencollection: 1.0.0
info:
  name: Sybase ASE REST API
  version: '16.0'
request:
  auth:
    type: basic
    username: '{{username}}'
    password: '{{password}}'
items:
- info:
    name: Servers
    type: folder
  items:
  - info:
      name: List ASE Servers
      type: http
    http:
      method: GET
      url: https://{server}:{port}/ase/v1/servers
    docs: Retrieves a list of SAP ASE server instances available for administration and monitoring through this API endpoint.
  - info:
      name: Get Server Details
      type: http
    http:
      method: GET
      url: https://{server}:{port}/ase/v1/servers/:serverId
      params:
      - name: serverId
        value: ''
        type: path
        description: The unique identifier of the SAP ASE server instance.
    docs: Retrieves detailed information about a specific SAP ASE server instance including version, status, uptime, and configuration
      summary.
  - info:
      name: Get Server Status
      type: http
    http:
      method: GET
      url: https://{server}:{port}/ase/v1/servers/:serverId/status
      params:
      - name: serverId
        value: ''
        type: path
        description: The unique identifier of the SAP ASE server instance.
    docs: Retrieves the current operational status of a SAP ASE server including uptime, active connections, CPU utilization,
      and memory usage metrics.
- info:
    name: Databases
    type: folder
  items:
  - info:
      name: List Databases
      type: http
    http:
      method: GET
      url: https://{server}:{port}/ase/v1/servers/:serverId/databases
      params:
      - name: serverId
        value: ''
        type: path
        description: The unique identifier of the SAP ASE server instance.
    docs: Retrieves a list of all databases on the specified SAP ASE server including their status, size, and owner information.
  - info:
      name: Create a Database
      type: http
    http:
      method: POST
      url: https://{server}:{port}/ase/v1/servers/:serverId/databases
      params:
      - name: serverId
        value: ''
        type: path
        description: The unique identifier of the SAP ASE server instance.
      body:
        type: json
        data: '{}'
    docs: Creates a new database on the specified SAP ASE server with the provided configuration parameters including name,
      size, and device allocation.
  - info:
      name: Get Database Details
      type: http
    http:
      method: GET
      url: https://{server}:{port}/ase/v1/servers/:serverId/databases/:databaseName
      params:
      - name: serverId
        value: ''
        type: path
        description: The unique identifier of the SAP ASE server instance.
      - name: databaseName
        value: ''
        type: path
        description: The name of the database within the SAP ASE server.
    docs: Retrieves detailed information about a specific database including size, space usage, configuration options, and
      segment information.
- info:
    name: Performance
    type: folder
  items:
  - info:
      name: Get Performance Metrics
      type: http
    http:
      method: GET
      url: https://{server}:{port}/ase/v1/servers/:serverId/performance
      params:
      - name: serverId
        value: ''
        type: path
        description: The unique identifier of the SAP ASE server instance.
      - name: interval
        value: ''
        type: query
        description: The sampling interval in seconds for performance data collection.
    docs: Retrieves current performance metrics for the SAP ASE server including CPU utilization, disk I/O statistics, cache
      hit ratios, lock activity, and network throughput. Equivalent to data available from sp_sysmon.
  - info:
      name: Get Cache Performance Metrics
      type: http
    http:
      method: GET
      url: https://{server}:{port}/ase/v1/servers/:serverId/performance/cache
      params:
      - name: serverId
        value: ''
        type: path
        description: The unique identifier of the SAP ASE server instance.
    docs: Retrieves detailed cache performance statistics for the SAP ASE server including data cache hit ratios, procedure
      cache utilization, and buffer pool statistics for each named cache.
  - info:
      name: Get Lock Activity Metrics
      type: http
    http:
      method: GET
      url: https://{server}:{port}/ase/v1/servers/:serverId/performance/locks
      params:
      - name: serverId
        value: ''
        type: path
        description: The unique identifier of the SAP ASE server instance.
    docs: Retrieves lock management statistics including lock contention, deadlock occurrences, lock wait times, and lock
      promotion activity for the SAP ASE server.
- info:
    name: Users
    type: folder
  items:
  - info:
      name: List Server Logins
      type: http
    http:
      method: GET
      url: https://{server}:{port}/ase/v1/servers/:serverId/logins
      params:
      - name: serverId
        value: ''
        type: path
        description: The unique identifier of the SAP ASE server instance.
    docs: Retrieves a list of all server-level logins configured on the SAP ASE server including their roles, default databases,
      and status.
  - info:
      name: Create a Server Login
      type: http
    http:
      method: POST
      url: https://{server}:{port}/ase/v1/servers/:serverId/logins
      params:
      - name: serverId
        value: ''
        type: path
        description: The unique identifier of the SAP ASE server instance.
      body:
        type: json
        data: '{}'
    docs: Creates a new server-level login on the SAP ASE server with the specified credentials, default database, and role
      assignments.
- info:
    name: Backups
    type: folder
  items:
  - info:
      name: List Backup History
      type: http
    http:
      method: GET
      url: https://{server}:{port}/ase/v1/servers/:serverId/backups
      params:
      - name: serverId
        value: ''
        type: path
        description: The unique identifier of the SAP ASE server instance.
      - name: databaseName
        value: ''
        type: query
        description: Filter backup history by database name.
    docs: Retrieves the backup history for the specified SAP ASE server including completed, in-progress, and scheduled backup
      operations.
  - info:
      name: Initiate a Database Backup
      type: http
    http:
      method: POST
      url: https://{server}:{port}/ase/v1/servers/:serverId/backups
      params:
      - name: serverId
        value: ''
        type: path
        description: The unique identifier of the SAP ASE server instance.
      body:
        type: json
        data: '{}'
    docs: Initiates a new backup operation for the specified database on the SAP ASE server. Supports full database dumps,
      transaction log dumps, and incremental backups.
- info:
    name: Devices
    type: folder
  items:
  - info:
      name: List Database Devices
      type: http
    http:
      method: GET
      url: https://{server}:{port}/ase/v1/servers/:serverId/devices
      params:
      - name: serverId
        value: ''
        type: path
        description: The unique identifier of the SAP ASE server instance.
    docs: Retrieves a list of all database devices configured on the SAP ASE server including their physical paths, sizes,
      and usage information.
- info:
    name: Configuration
    type: folder
  items:
  - info:
      name: Get Server Configuration
      type: http
    http:
      method: GET
      url: https://{server}:{port}/ase/v1/servers/:serverId/configuration
      params:
      - name: serverId
        value: ''
        type: path
        description: The unique identifier of the SAP ASE server instance.
      - name: group
        value: ''
        type: query
        description: Filter configuration parameters by group name.
    docs: Retrieves the current server configuration parameters for the SAP ASE instance. Returns settings equivalent to those
      available through sp_configure, organized by configuration groups.
  - info:
      name: Update Server Configuration
      type: http
    http:
      method: PUT
      url: https://{server}:{port}/ase/v1/servers/:serverId/configuration
      params:
      - name: serverId
        value: ''
        type: path
        description: The unique identifier of the SAP ASE server instance.
      body:
        type: json
        data: '{}'
    docs: Updates one or more server configuration parameters on the SAP ASE instance. Some parameters require a server restart
      to take effect.
bundled: true