YugabyteDB Ybc Management API

The Ybc Management API from YugabyteDB — 5 operation(s) for ybc management.

Documentation GitHub OpenAPI

Operations 5

PUT /api/v1/customers/{cUUID}/universes/{uniUUID}/ybc/disable Disable YBC on the universe nodes #

PUT /api/v1/customers/{cUUID}/universes/{uniUUID}/ybc/install Install YBC on the universe nodes #

PUT /api/v1/customers/{cUUID}/universes/{uniUUID}/ybc/upgrade Upgrade YBC on the universe nodes #

PUT /api/v1/customers/{cUUID}/universes/{uniUUID}/ybc/upgrade/gflags Upgrade YBC gflags on the universe nodes #

POST /api/v1/customers/{cUUID}/universes/{uniUUID}/ybc_throttle_params_async Set throttle params in YB-Controller( async ) #

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-ybc-management-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 Ybc Management API
  version: v1
  contact:
    name: 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
  termsOfService: TODO(chirag)
  x-refined-note:
  - x-source differs across the merged source definitions and was not carried
  - x-split-from differs across the merged source definitions and was not carried
  description: 'Operations tagged Ybc Management across 3 of this provider''s published API definitions: openapi_2.yaml, yugabytedb-anywhere-v1-full.yaml, yugabytedb-anywhere-v1-universes.yaml. Each path carries the servers of the definition it was published in.'
servers:
- url: /
tags:
- name: Ybc Management
paths:
  /api/v1/customers/{cUUID}/universes/{uniUUID}/ybc/disable:
    put:
      description: YbaApi Internal.
      operationId: disableYbc
      parameters:
      - in: path
        name: cUUID
        required: true
        schema:
          format: uuid
          type: string
      - in: path
        name: uniUUID
        required: true
        schema:
          format: uuid
          type: string
      - in: query
        name: request
        schema: {}
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/YBPTask'
          description: successful operation
      security:
      - apiKeyAuth: []
      summary: Disable YBC on the universe nodes
      tags:
      - Ybc Management
    servers:
    - url: /
  /api/v1/customers/{cUUID}/universes/{uniUUID}/ybc/install:
    put:
      description: YbaApi Internal.
      operationId: installYbc
      parameters:
      - in: path
        name: cUUID
        required: true
        schema:
          format: uuid
          type: string
      - in: path
        name: uniUUID
        required: true
        schema:
          format: uuid
          type: string
      - in: query
        name: ybcVersion
        schema:
          type: string
      - in: query
        name: request
        schema: {}
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/YBPTask'
          description: successful operation
      security:
      - apiKeyAuth: []
      summary: Install YBC on the universe nodes
      tags:
      - Ybc Management
    servers:
    - url: /
  /api/v1/customers/{cUUID}/universes/{uniUUID}/ybc/upgrade:
    put:
      description: YbaApi Internal.
      operationId: upgradeYbc
      parameters:
      - in: path
        name: cUUID
        required: true
        schema:
          format: uuid
          type: string
      - in: path
        name: uniUUID
        required: true
        schema:
          format: uuid
          type: string
      - in: query
        name: ybcVersion
        schema:
          type: string
      - in: query
        name: request
        schema: {}
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/YBPTask'
          description: successful operation
      security:
      - apiKeyAuth: []
      summary: Upgrade YBC on the universe nodes
      tags:
      - Ybc Management
    servers:
    - url: /
  /api/v1/customers/{cUUID}/universes/{uniUUID}/ybc/upgrade/gflags:
    put:
      description: YbaApi Internal.
      operationId: upgradeYbcGflags
      parameters:
      - in: path
        name: cUUID
        required: true
        schema:
          format: uuid
          type: string
      - in: path
        name: uniUUID
        required: true
        schema:
          format: uuid
          type: string
      - in: query
        name: request
        schema: {}
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/YBPTask'
          description: successful operation
      security:
      - apiKeyAuth: []
      summary: Upgrade YBC gflags on the universe nodes
      tags:
      - Ybc Management
    servers:
    - url: /
  /api/v1/customers/{cUUID}/universes/{uniUUID}/ybc_throttle_params_async:
    post:
      operationId: setThrottleParams
      parameters:
      - in: path
        name: cUUID
        required: true
        schema:
          format: uuid
          type: string
      - in: path
        name: uniUUID
        required: true
        schema:
          format: uuid
          type: string
      - in: query
        name: request
        schema: {}
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/YbcThrottleParameters'
        description: Parameters for YB-Controller throttling
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/YBPSuccess'
          description: successful operation
      security:
      - apiKeyAuth: []
      summary: Set throttle params in YB-Controller( async )
      tags:
      - Ybc Management
      x-codegen-request-body-name: throttleParams
    servers:
    - url: /
components:
  schemas:
    YBPTask:
      example:
        taskUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
        resourceUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
      properties:
        resourceUUID:
          description: UUID of the resource being modified by the task
          format: uuid
          readOnly: true
          type: string
        taskUUID:
          description: Task UUID
          format: uuid
          readOnly: true
          type: string
      type: object
    YBPSuccess:
      example:
        success: true
        message: message
      properties:
        message:
          description: API response message.
          readOnly: true
          type: string
        success:
          description: API operation status. A value of true indicates the operation was successful.
          readOnly: true
          type: boolean
      type: object
    YbcThrottleParameters:
      description: YB-Controller throttle parameters
      example:
        diskWriteBytesPerSecond: 6
        maxConcurrentDownloads: 1
        maxConcurrentUploads: 5
        perDownloadNumObjects: 5
        diskReadBytesPerSecond: 0
        perUploadNumObjects: 2
        resetDefaults: true
      properties:
        diskReadBytesPerSecond:
          description: 'WARNING: This is a preview API that could change. Disk read bytes per second to throttle disk usage during backups'
          format: int64
          type: integer
        diskWriteBytesPerSecond:
          description: 'WARNING: This is a preview API that could change. Disk write bytes per second to throttle disk usage during restore'
          format: int64
          type: integer
        maxConcurrentDownloads:
          description: Max concurrent downloads per node
          format: int64
          type: integer
        maxConcurrentUploads:
          description: Max concurrent uploads per node
          format: int64
          type: integer
        perDownloadNumObjects:
          description: Max objects per download per node
          format: int64
          type: integer
        perUploadNumObjects:
          description: Max objects per upload per node
          format: int64
          type: integer
        resetDefaults:
          description: Unset Throttle parameters in YB-Controller
          type: boolean
      type: object
    YBPTask_2:
      example:
        taskUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
        resourceUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
      properties:
        resourceUUID:
          description: UUID of the resource being modified by the task
          format: uuid
          readOnly: true
          type: string
          example: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
        taskUUID:
          description: Task UUID
          format: uuid
          readOnly: true
          type: string
          example: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
      type: object
    YBPSuccess_2:
      example:
        success: true
        message: message
      properties:
        message:
          description: API response message.
          readOnly: true
          type: string
          example: Example message
        success:
          description: API operation status. A value of true indicates the operation was successful.
          readOnly: true
          type: boolean
          example: true
      type: object
    YbcThrottleParameters_2:
      description: YB-Controller throttle parameters
      example:
        diskWriteBytesPerSecond: 6
        maxConcurrentDownloads: 1
        maxConcurrentUploads: 5
        perDownloadNumObjects: 5
        diskReadBytesPerSecond: 0
        perUploadNumObjects: 2
        resetDefaults: true
      properties:
        diskReadBytesPerSecond:
          description: 'WARNING: This is a preview API that could change. Disk read bytes per second to throttle disk usage during backups'
          format: int64
          type: integer
          example: 1000
        diskWriteBytesPerSecond:
          description: 'WARNING: This is a preview API that could change. Disk write bytes per second to throttle disk usage during restore'
          format: int64
          type: integer
          example: 1000
        maxConcurrentDownloads:
          description: Max concurrent downloads per node
          format: int64
          type: integer
          example: 10
        maxConcurrentUploads:
          description: Max concurrent uploads per node
          format: int64
          type: integer
          example: 10
        perDownloadNumObjects:
          description: Max objects per download per node
          format: int64
          type: integer
          example: 10
        perUploadNumObjects:
          description: Max objects per upload per node
          format: int64
          type: integer
          example: 10
        resetDefaults:
          description: Unset Throttle parameters in YB-Controller
          type: boolean
          example: true
      type: object
    YBPTask_3:
      example:
        taskUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
        resourceUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
      properties:
        resourceUUID:
          description: UUID of the resource being modified by the task
          format: uuid
          readOnly: true
          type: string
          example: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
        taskUUID:
          description: Task UUID
          format: uuid
          readOnly: true
          type: string
          example: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
      type: object
    YBPSuccess_3:
      example:
        success: true
        message: message
      properties:
        message:
          description: API response message.
          readOnly: true
          type: string
          example: Example message
        success:
          description: API operation status. A value of true indicates the operation was successful.
          readOnly: true
          type: boolean
          example: true
      type: object
    YbcThrottleParameters_3:
      description: YB-Controller throttle parameters
      example:
        diskWriteBytesPerSecond: 6
        maxConcurrentDownloads: 1
        maxConcurrentUploads: 5
        perDownloadNumObjects: 5
        diskReadBytesPerSecond: 0
        perUploadNumObjects: 2
        resetDefaults: true
      properties:
        diskReadBytesPerSecond:
          description: 'WARNING: This is a preview API that could change. Disk read bytes per second to throttle disk usage during backups'
          format: int64
          type: integer
          example: 1000
        diskWriteBytesPerSecond:
          description: 'WARNING: This is a preview API that could change. Disk write bytes per second to throttle disk usage during restore'
          format: int64
          type: integer
          example: 1000
        maxConcurrentDownloads:
          description: Max concurrent downloads per node
          format: int64
          type: integer
          example: 10
        maxConcurrentUploads:
          description: Max concurrent uploads per node
          format: int64
          type: integer
          example: 10
        perDownloadNumObjects:
          description: Max objects per download per node
          format: int64
          type: integer
          example: 10
        perUploadNumObjects:
          description: Max objects per upload per node
          format: int64
          type: integer
          example: 10
        resetDefaults:
          description: Unset Throttle parameters in YB-Controller
          type: boolean
          example: true
      type: object
  securitySchemes:
    apiKeyAuth:
      description: API token passed as header
      in: header
      name: X-AUTH-YW-API-TOKEN
      type: apiKey
externalDocs:
  description: About YugabyteDB Anywhere
  url: https://docs.yugabyte.com/latest/yugabyte-platform/
x-refined-from:
- openapi_2.yaml
- yugabytedb-anywhere-v1-full.yaml
- yugabytedb-anywhere-v1-universes.yaml