Yugabyte

Yugabyte backup-info API

APIs for getting backup Details

Documentation GitHub OpenAPI

Operations 1

GET /backup Get Backup Details #

Specifications

⚙

OpenAPI

https://raw.githubusercontent.com/api-evangelist/yugabyte/refs/heads/main/openapi/yugabyte-backup-info-api-openapi.yml

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this

find_apisBrowse and filter every API in the catalog.
get_api_artifactsOne API's artifacts, grouped by type.
get_openapiThe primary OpenAPI for this API.
find_similar_apisAPIs that look like this one.
apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
resolveTurn a domain, URL or GitHub org into the provider it belongs to.
find_cohortsEvery scored population of providers in the catalog.

All 92 tools →

Call it yourself

curl for this page

This API

curl "https://apis.io/api/v1/apis/yugabyte-backup-info-api"

All apis

curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no email required.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

openapi: 3.2.0
info:
  contact:
    email: support@yugabyte.com
    name: Yugabyte Cloud Support
    url: https://support.yugabyte.com/
  description: YugabyteDB as a Service
  license:
    name: Properietary (TBD)
    url: https://www.yugabyte.com/yugabyte-cloud-terms-of-service
  termsOfService: https://www.yugabyte.com/yugabyte-cloud-terms-of-service
  title: Yugabyte Cloud Backup Info API
  version: v1
servers:
- description: Endpoint of the API server
  url: '{protocol}://{host_port}/api'
  variables:
    protocol:
      default: http
      enum:
      - http
      - https
    host_port:
      default: localhost:1323
security:
- BearerAuthToken: []
tags:
- description: APIs for getting backup Details
  name: backup-info
paths:
  /backup:
    get:
      description: Retrieve the list of databases on which backup is enabled.
      operationId: getBackupDetails
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Backup_Details'
          description: Retrieve the list of databases on which backup is enabled in the YugabyteDB cluster.
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: API Error
        '500':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: API Error
      summary: Get Backup Details
      tags:
      - backup-info
components:
  schemas:
    BackupDetails:
      description: Details of backup enabled on databases in YugabyteDB cluster
      example:
        bytes_transferred: bytes_transferred
        actual_size: actual_size
        user_operation: user_operation
        task_status: task_status
        database_keyspace: database_keyspace
        ybdb_api: ybdb_api
        ybc_task_id: ybc_task_id
        tserver_ip: tserver_ip
        time_taken: time_taken
        task_start_time: task_start_time
      properties:
        ybc_task_id:
          type: string
        tserver_ip:
          type: string
        user_operation:
          type: string
        ybdb_api:
          type: string
        database_keyspace:
          type: string
        task_start_time:
          type: string
        task_status:
          type: string
        time_taken:
          type: string
        bytes_transferred:
          type: string
        actual_size:
          type: string
      required:
      - actual_size
      - bytes_transferred
      - database_keyspace
      - task_start_time
      - task_status
      - time_taken
      - tserver_ip
      - user_operation
      - ybc_task_id
      - ybdb_api
      title: Get Backup Details
      type: object
    Backup_Details:
      example:
        backup:
        - bytes_transferred: bytes_transferred
          actual_size: actual_size
          user_operation: user_operation
          task_status: task_status
          database_keyspace: database_keyspace
          ybdb_api: ybdb_api
          ybc_task_id: ybc_task_id
          tserver_ip: tserver_ip
          time_taken: time_taken
          task_start_time: task_start_time
        - bytes_transferred: bytes_transferred
          actual_size: actual_size
          user_operation: user_operation
          task_status: task_status
          database_keyspace: database_keyspace
          ybdb_api: ybdb_api
          ybc_task_id: ybc_task_id
          tserver_ip: tserver_ip
          time_taken: time_taken
          task_start_time: task_start_time
      properties:
        backup:
          items:
            $ref: '#/components/schemas/BackupDetails'
          type: array
          uniqueItems: true
      required:
      - backup
      title: Backup Details
      type: object
    ApiError_error:
      properties:
        detail:
          description: Error message
          type: string
        status:
          description: Error code
          type: integer
      type: object
    ApiError:
      properties:
        error:
          $ref: '#/components/schemas/ApiError_error'
      title: API Error
      type: object
  securitySchemes:
    BearerAuthToken:
      bearerFormat: JWT
      scheme: bearer
      type: http