YugabyteDB

YugabyteDB preview API

The preview API from YugabyteDB — 2 operation(s) for preview.

Documentation GitHub OpenAPI

Operations 5

GET /api/v1/customers/{cUUID}/providers/{pUUID}/image_bundle List image bundles #

POST /api/v1/customers/{cUUID}/providers/{pUUID}/image_bundle Create a image bundle #

DELETE /api/v1/customers/{cUUID}/providers/{pUUID}/image_bundle/{iBUUID} Delete a image bundle #

GET /api/v1/customers/{cUUID}/providers/{pUUID}/image_bundle/{iBUUID} Get a image bundle #

PUT /api/v1/customers/{cUUID}/providers/{pUUID}/image_bundle/{iBUUID} Update a image bundle #

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-preview-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 Preview 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 preview across 3 of this provider''s published API definitions: openapi_2.yaml, yugabytedb-anywhere-v1-full.yaml, yugabytedb-anywhere-v1-releases-maintenance.yaml. Each path carries the servers of the definition it was published in.'
servers:
- url: /
tags:
- name: preview
paths:
  /api/v1/customers/{cUUID}/providers/{pUUID}/image_bundle:
    get:
      description: 'WARNING: This is a preview API that could change.'
      operationId: getListOfImageBundles
      parameters:
      - in: path
        name: cUUID
        required: true
        schema:
          format: uuid
          type: string
      - in: path
        name: pUUID
        required: true
        schema:
          format: uuid
          type: string
      - in: query
        name: arch
        schema:
          default: 'null'
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ImageBundle'
                type: array
          description: successful operation
      security:
      - apiKeyAuth: []
      summary: List image bundles
      tags:
      - preview
    post:
      description: 'WARNING: This is a preview API that could change.'
      operationId: createImageBundle
      parameters:
      - in: path
        name: cUUID
        required: true
        schema:
          format: uuid
          type: string
      - in: path
        name: pUUID
        required: true
        schema:
          format: uuid
          type: string
      - in: query
        name: request
        schema: {}
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ImageBundle'
        description: CreateImageBundleRequest
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ImageBundle'
          description: successful operation
      security:
      - apiKeyAuth: []
      summary: Create a image bundle
      tags:
      - preview
      x-codegen-request-body-name: body
    servers:
    - url: /
  /api/v1/customers/{cUUID}/providers/{pUUID}/image_bundle/{iBUUID}:
    delete:
      description: 'WARNING: This is a preview API that could change.'
      operationId: delete
      parameters:
      - in: path
        name: cUUID
        required: true
        schema:
          format: uuid
          type: string
      - in: path
        name: pUUID
        required: true
        schema:
          format: uuid
          type: string
      - in: path
        name: iBUUID
        required: true
        schema:
          format: uuid
          type: string
      - in: query
        name: request
        schema: {}
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/YBPSuccess'
          description: successful operation
      security:
      - apiKeyAuth: []
      summary: Delete a image bundle
      tags:
      - preview
    get:
      description: 'WARNING: This is a preview API that could change.'
      operationId: getImageBundle
      parameters:
      - in: path
        name: cUUID
        required: true
        schema:
          format: uuid
          type: string
      - in: path
        name: pUUID
        required: true
        schema:
          format: uuid
          type: string
      - in: path
        name: iBUUID
        required: true
        schema:
          format: uuid
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ImageBundle'
          description: successful operation
      security:
      - apiKeyAuth: []
      summary: Get a image bundle
      tags:
      - preview
    put:
      description: 'WARNING: This is a preview API that could change.'
      operationId: editImageBundle
      parameters:
      - in: path
        name: cUUID
        required: true
        schema:
          format: uuid
          type: string
      - in: path
        name: pUUID
        required: true
        schema:
          format: uuid
          type: string
      - in: path
        name: iBUUID
        required: true
        schema:
          format: uuid
          type: string
      - in: query
        name: request
        schema: {}
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ImageBundle'
        description: EditImageBundleRequest
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ImageBundle'
          description: successful operation
      security:
      - apiKeyAuth: []
      summary: Update a image bundle
      tags:
      - preview
      x-codegen-request-body-name: body
    servers:
    - url: /
components:
  schemas:
    ImageBundle:
      example:
        metadata:
          type: YBA_ACTIVE
          version: version
        useAsDefault: true
        name: name
        active: true
        details:
          sshPort: 5
          regions:
            key:
              sshUserOverride: sshUserOverride
              ybImage: ybImage
              sshPortOverride: 1
          useIMDSv2: true
          globalYbImage: globalYbImage
          sshUser: sshUser
          arch: x86_64
        uuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
      properties:
        active:
          description: Is the ImageBundle Active
          type: boolean
        details:
          $ref: '#/components/schemas/ImageBundleDetails'
        metadata:
          $ref: '#/components/schemas/Metadata'
        name:
          description: Image Bundle Name
          type: string
        useAsDefault:
          description: Default Image Bundle. A provider can have two defaults, one per architecture
          type: boolean
        uuid:
          description: Image Bundle UUID
          format: uuid
          readOnly: true
          type: string
      type: object
    Metadata:
      example:
        type: YBA_ACTIVE
        version: version
      properties:
        type:
          enum:
          - YBA_ACTIVE
          - YBA_DEPRECATED
          - CUSTOM
          type: string
        version:
          type: string
      required:
      - type
      - version
      type: object
    ImageBundleDetails:
      example:
        sshPort: 5
        regions:
          key:
            sshUserOverride: sshUserOverride
            ybImage: ybImage
            sshPortOverride: 1
        useIMDSv2: true
        globalYbImage: globalYbImage
        sshUser: sshUser
        arch: x86_64
      properties:
        arch:
          description: Architecture type for the image bundle
          enum:
          - x86_64
          - aarch64
          type: string
        globalYbImage:
          description: Global YB image for the bundle
          type: string
        regions:
          additionalProperties:
            $ref: '#/components/schemas/BundleInfo'
          description: Regions override for image bundle
          type: object
        sshPort:
          format: int32
          type: integer
        sshUser:
          type: string
        useIMDSv2:
          type: boolean
      type: object
    BundleInfo:
      example:
        sshUserOverride: sshUserOverride
        ybImage: ybImage
        sshPortOverride: 1
      properties:
        sshPortOverride:
          description: sshPortOverride for the bundle. <b style="color:#ff0000">Deprecated since YBA version 2.20.3.0.</b> Use imageBundles.details.sshUser instead.
          format: int32
          type: integer
        sshUserOverride:
          description: sshUserOverride for the bundle. <b style="color:#ff0000">Deprecated since YBA version 2.20.3.0.</b> Use imageBundles.details.sshUser instead.
          type: string
        ybImage:
          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
    ImageBundle_2:
      example:
        metadata:
          type: YBA_ACTIVE
          version: version
        useAsDefault: true
        name: name
        active: true
        details:
          sshPort: 5
          regions:
            key:
              sshUserOverride: sshUserOverride
              ybImage: ybImage
              sshPortOverride: 1
          useIMDSv2: true
          globalYbImage: globalYbImage
          sshUser: sshUser
          arch: x86_64
        uuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
      properties:
        active:
          description: Is the ImageBundle Active
          type: boolean
          example: true
        details:
          $ref: '#/components/schemas/ImageBundleDetails_2'
        metadata:
          $ref: '#/components/schemas/Metadata_2'
        name:
          description: Image Bundle Name
          type: string
          example: example-name
        useAsDefault:
          description: Default Image Bundle. A provider can have two defaults, one per architecture
          type: boolean
          example: true
        uuid:
          description: Image Bundle UUID
          format: uuid
          readOnly: true
          type: string
          example: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
      type: object
    Metadata_2:
      example:
        type: YBA_ACTIVE
        version: version
      properties:
        type:
          enum:
          - YBA_ACTIVE
          - YBA_DEPRECATED
          - CUSTOM
          type: string
          example: YBA_ACTIVE
        version:
          type: string
          example: 2.20.0.0
      required:
      - type
      - version
      type: object
    ImageBundleDetails_2:
      example:
        sshPort: 5
        regions:
          key:
            sshUserOverride: sshUserOverride
            ybImage: ybImage
            sshPortOverride: 1
        useIMDSv2: true
        globalYbImage: globalYbImage
        sshUser: sshUser
        arch: x86_64
      properties:
        arch:
          description: Architecture type for the image bundle
          enum:
          - x86_64
          - aarch64
          type: string
          example: x86_64
        globalYbImage:
          description: Global YB image for the bundle
          type: string
          example: example-globalYbImage
        regions:
          additionalProperties:
            $ref: '#/components/schemas/BundleInfo_2'
          description: Regions override for image bundle
          type: object
          example: {}
        sshPort:
          format: int32
          type: integer
          example: 5433
        sshUser:
          type: string
          example: example-sshUser
        useIMDSv2:
          type: boolean
          example: true
      type: object
    BundleInfo_2:
      example:
        sshUserOverride: sshUserOverride
        ybImage: ybImage
        sshPortOverride: 1
      properties:
        sshPortOverride:
          description: sshPortOverride for the bundle. <b style="color:#ff0000">Deprecated since YBA version 2.20.3.0.</b> Use imageBundles.details.sshUser instead.
          format: int32
          type: integer
          example: 5433
        sshUserOverride:
          description: sshUserOverride for the bundle. <b style="color:#ff0000">Deprecated since YBA version 2.20.3.0.</b> Use imageBundles.details.sshUser instead.
          type: string
          example: example-sshUserOverride
        ybImage:
          type: string
          example: example-ybImage
      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
    ImageBundle_3:
      example:
        metadata:
          type: YBA_ACTIVE
          version: version
        useAsDefault: true
        name: name
        active: true
        details:
          sshPort: 5
          regions:
            key:
              sshUserOverride: sshUserOverride
              ybImage: ybImage
              sshPortOverride: 1
          useIMDSv2: true
          globalYbImage: globalYbImage
          sshUser: sshUser
          arch: x86_64
        uuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
      properties:
        active:
          description: Is the ImageBundle Active
          type: boolean
          example: true
        details:
          $ref: '#/components/schemas/ImageBundleDetails_3'
        metadata:
          $ref: '#/components/schemas/Metadata_3'
        name:
          description: Image Bundle Name
          type: string
          example: example-name
        useAsDefault:
          description: Default Image Bundle. A provider can have two defaults, one per architecture
          type: boolean
          example: true
        uuid:
          description: Image Bundle UUID
          format: uuid
          readOnly: true
          type: string
          example: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
      type: object
    Metadata_3:
      example:
        type: YBA_ACTIVE
        version: version
      properties:
        type:
          enum:
          - YBA_ACTIVE
          - YBA_DEPRECATED
          - CUSTOM
          type: string
          example: YBA_ACTIVE
        version:
          type: string
          example: 2.20.0.0
      required:
      - type
      - version
      type: object
    ImageBundleDetails_3:
      example:
        sshPort: 5
        regions:
          key:
            sshUserOverride: sshUserOverride
            ybImage: ybImage
            sshPortOverride: 1
        useIMDSv2: true
        globalYbImage: globalYbImage
        sshUser: sshUser
        arch: x86_64
      properties:
        arch:
          description: Architecture type for the image bundle
          enum:
          - x86_64
          - aarch64
          type: string
          example: x86_64
        globalYbImage:
          description: Global YB image for the bundle
          type: string
          example: example-globalYbImage
        regions:
          additionalProperties:
            $ref: '#/components/schemas/BundleInfo_3'
          description: Regions override for image bundle
          type: object
          example: {}
        sshPort:
          format: int32
          type: integer
          example: 5433
        sshUser:
          type: string
          example: example-sshUser
        useIMDSv2:
          type: boolean
          example: true
      type: object
    BundleInfo_3:
      example:
        sshUserOverride: sshUserOverride
        ybImage: ybImage
        sshPortOverride: 1
      properties:
        sshPortOverride:
          description: sshPortOverride for the bundle. <b style="color:#ff0000">Deprecated since YBA version 2.20.3.0.</b> Use imageBundles.details.sshUser instead.
          format: int32
          type: integer
          example: 5433
        sshUserOverride:
          description: sshUserOverride for the bundle. <b style="color:#ff0000">Deprecated since YBA version 2.20.3.0.</b> Use imageBundles.details.sshUser instead.
          type: string
          example: example-sshUserOverride
        ybImage:
          type: string
          example: example-ybImage
      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
  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-releases-maintenance.yaml