YugabyteDB

YugabyteDB Backup and Restore API

Operations related to universe backup and restore

Documentation GitHub OpenAPI

Operations 1

GET /ybc/gflags-metadata List YBC Gflags metadata #

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/yugabytedb-backup-and-restore-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 form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

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

OpenAPI Specification

openapi: 3.2.0
info:
  title: Yugabytedb Backup and Restore API
  version: v2
  contact:
    email: support@yugabyte.com
    name: YugabyteDB Anywhere Support
    url: https://docs.yugabyte.com
  license:
    name: Polyform Free Trial License 1.0.0
    url: https://github.com/yugabyte/yugabyte-db/blob/master/licenses/POLYFORM-FREE-TRIAL-LICENSE-1.0.0.txt
  description: 'Operations tagged Backup and Restore across 2 of this provider''s published API definitions: openapi.yaml, yugabytedb-anywhere-v2-openapi.yaml. Each path carries the servers of the definition it was published in.'
servers:
- description: API endpoint of YBA server
  url: '{protocol}://{host_port}/api/v2'
  variables:
    protocol:
      default: http
      enum:
      - http
      - https
    host_port:
      default: localhost:9000
tags:
- description: Operations related to universe backup and restore
  name: Backup and Restore
paths:
  /ybc/gflags-metadata:
    get:
      description: Get list of all YBC gflags and related metadata.
      operationId: listYbcGflagsMetadata
      responses:
        '200':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/GflagMetadata'
                type: array
          description: OK
        '404':
          description: Not found
      security:
      - apiKeyAuth: []
      summary: List YBC Gflags metadata
      tags:
      - Backup and Restore
      x-yba-api-audit:
        noAudit: true
      x-yba-api-authz:
      - requiredPermission:
          resourceType: other
          action: read
        resourceLocation:
          path: customers
          sourceType: endpoint
      x-yba-api-since: 2024.2.0.0
      x-yba-api-visibility: preview
      x-accepts:
      - application/json
    servers:
    - description: API endpoint of YBA server
      url: '{protocol}://{host_port}/api/v2'
      variables:
        protocol:
          default: http
          enum:
          - http
          - https
        host_port:
          default: localhost:9000
components:
  schemas:
    GflagMetadata:
      description: Metadata for Gflags of YB Controller.
      example:
        default: default
        meaning: meaning
        name: name
        type: type
      properties:
        name:
          description: The name of the flag.
          type: string
        meaning:
          description: A brief description of what the flag does.
          type: string
        default:
          description: The default value of the flag.
          type: string
        type:
          description: The data type of the flag.
          type: string
      title: GflagMetadata
      type: object
    GflagMetadata_2:
      description: Metadata for Gflags of YB Controller.
      example:
        default: default
        meaning: meaning
        name: name
        type: type
      properties:
        name:
          description: The name of the flag.
          type: string
          example: example-name
        meaning:
          description: A brief description of what the flag does.
          type: string
          example: example-meaning
        default:
          description: The default value of the flag.
          type: string
          example: example-default
        type:
          description: The data type of the flag.
          type: string
          example: DEFAULT
      title: GflagMetadata
      type: object
  securitySchemes:
    apiKeyAuth:
      in: header
      name: X-AUTH-YW-API-TOKEN
      type: apiKey
x-refined-from:
- openapi.yaml
- yugabytedb-anywhere-v2-openapi.yaml