openapi: 3.2.0
info:
  contact:
    name: https://docs.yugabyte.com
  description: ALPHA - NOT FOR EXTERNAL USE
  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)
  title: YugabyteDB Anywhere Ybc Management API
  version: v1
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
  /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
  /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
  /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
  /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
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
  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-original-swagger-version: '2.0'