YugabyteDB

YugabyteDB Release management API

The Release management API from YugabyteDB — 3 operation(s) for release management.

GitHub OpenAPI

Operations 6

GET /api/v1/customers/{cUUID}/providers/{pUUID}/releases List releases by provider - deprecated #
GET /api/v1/customers/{cUUID}/releases Deprecated: sinceVersion: 2024.1. Use ReleasesController.list instead. List all releases #
POST /api/v1/customers/{cUUID}/releases Deprecated: sinceVersion 2024.1. Use ReleasesController.create instead. Create a release #
PUT /api/v1/customers/{cUUID}/releases Refresh a release #
DELETE /api/v1/customers/{cUUID}/releases/{name} Deprecated: sinceVersion: 2024.1. Use ReleasesController.delete instead. Delete a release #
PUT /api/v1/customers/{cUUID}/releases/{name} Deprecated: sinceVersion: 2024.1. Use ReleasesController.update instead. Update a release #

Documentation

📖
Documentation
https://docs.yugabyte.com/stable/yugabyte-cloud/managed-automation/managed-api/
📖
APIReference
https://api-docs.yugabyte.com/docs/managed-apis/
📖
GettingStarted
https://docs.yugabyte.com/stable/yugabyte-cloud/managed-automation/managed-api/managed-apikeys/
📖
Authentication
https://docs.yugabyte.com/stable/yugabyte-cloud/managed-automation/managed-api/managed-apikeys/
📖
Documentation
https://docs.yugabyte.com/stable/yugabyte-platform/anywhere-automation/anywhere-api/
📖
APIReference
https://api-docs.yugabyte.com/docs/yugabyte-platform/
📖
GettingStarted
https://docs.yugabyte.com/stable/yugabyte-platform/anywhere-automation/anywhere-api/
📖
Authentication
https://docs.yugabyte.com/stable/yugabyte-platform/anywhere-automation/anywhere-api/

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/yugabytedb/refs/heads/main/openapi/yugabytedb-release-management-api-openapi.yml

Other Resources

🔗
CLI
https://github.com/yugabyte/ybm-cli
🔗
Integrations
https://github.com/yugabyte/terraform-provider-ybm
🔗
TermsOfService
https://www.yugabyte.com/yugabytedb-managed-service-terms/
🔗
SDKs
https://github.com/yugabyte/platform-go-client
🔗
Integrations
https://github.com/yugabyte/terraform-provider-yba
🔗
Integrations
https://github.com/yugabyte/yugabyte-k8s-operator
🔗
KubernetesCRD
https://raw.githubusercontent.com/api-evangelist/yugabytedb/refs/heads/main/crd/yugabytedb-ybuniverse.yaml
🔗
KubernetesCRD
https://raw.githubusercontent.com/api-evangelist/yugabytedb/refs/heads/main/crd/yugabytedb-backup.yaml
🔗
KubernetesCRD
https://raw.githubusercontent.com/api-evangelist/yugabytedb/refs/heads/main/crd/yugabytedb-backup-schedule.yaml
🔗
KubernetesCRD
https://raw.githubusercontent.com/api-evangelist/yugabytedb/refs/heads/main/crd/yugabytedb-restore-job.yaml
🔗
KubernetesCRD
https://raw.githubusercontent.com/api-evangelist/yugabytedb/refs/heads/main/crd/yugabytedb-storage-config.yaml
🔗
KubernetesCRD
https://raw.githubusercontent.com/api-evangelist/yugabytedb/refs/heads/main/crd/yugabytedb-dr-config.yaml
🔗
KubernetesCRD
https://raw.githubusercontent.com/api-evangelist/yugabytedb/refs/heads/main/crd/yugabytedb-pitr-config.yaml
🔗
KubernetesCRD
https://raw.githubusercontent.com/api-evangelist/yugabytedb/refs/heads/main/crd/yugabytedb-release.yaml
🔗
KubernetesCRD
https://raw.githubusercontent.com/api-evangelist/yugabytedb/refs/heads/main/crd/yugabytedb-support-bundle.yaml
🔗
KubernetesCRD
https://raw.githubusercontent.com/api-evangelist/yugabytedb/refs/heads/main/crd/yugabytedb-ybcertificate.yaml
🔗
KubernetesCRD
https://raw.githubusercontent.com/api-evangelist/yugabytedb/refs/heads/main/crd/yugabytedb-ybprovider.yaml
🔗
KubernetesCRD
https://raw.githubusercontent.com/api-evangelist/yugabytedb/refs/heads/main/crd/yugabytedb-ybplatform.yaml

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-release-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

yugabytedb-release-management-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Yugabytedb Release 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 Release management across 4 of this provider''s published API definitions: openapi_2.yaml, platform.swagger.json, 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: Release management
paths:
  /api/v1/customers/{cUUID}/providers/{pUUID}/releases:
    get:
      deprecated: true
      description: <b style="color:#ff0000">Deprecated since YBA version 2.20.0.0.</b></p>Use /api/v1/customers/{cUUID}/releases/:arch instead
      operationId: getListOfRegionReleases
      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: includeMetadata
        schema:
          default: false
          type: boolean
      responses:
        '200':
          content:
            application/json:
              schema:
                additionalProperties:
                  properties: {}
                  type: object
                type: object
          description: successful operation
      security:
      - apiKeyAuth: []
      summary: List releases by provider - deprecated
      tags:
      - Release management
    servers:
    - url: /
  /api/v1/customers/{cUUID}/releases:
    get:
      deprecated: true
      operationId: getListOfReleases
      parameters:
      - in: path
        name: cUUID
        required: true
        schema:
          format: uuid
          type: string
      - in: query
        name: includeMetadata
        schema:
          default: false
          type: boolean
      - in: query
        name: arch
        schema:
          default: 'null'
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                additionalProperties:
                  properties: {}
                  type: object
                type: object
          description: successful operation
      security:
      - apiKeyAuth: []
      summary: 'Deprecated: sinceVersion: 2024.1. Use ReleasesController.list instead. List all releases'
      tags:
      - Release management
    post:
      deprecated: true
      operationId: createRelease
      parameters:
      - in: path
        name: cUUID
        required: true
        schema:
          format: uuid
          type: string
      - in: query
        name: request
        schema: {}
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ReleaseFormData'
        description: Release data for remote downloading to be created
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/YBPSuccess'
          description: successful operation
      security:
      - apiKeyAuth: []
      summary: 'Deprecated: sinceVersion 2024.1. Use ReleasesController.create instead. Create a release'
      tags:
      - Release management
      x-codegen-request-body-name: Release
    put:
      operationId: refresh
      parameters:
      - in: path
        name: cUUID
        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: Refresh a release
      tags:
      - Release management
    servers:
    - url: /
  /api/v1/customers/{cUUID}/releases/{name}:
    delete:
      deprecated: true
      operationId: deleteRelease
      parameters:
      - in: path
        name: cUUID
        required: true
        schema:
          format: uuid
          type: string
      - in: path
        name: name
        required: true
        schema:
          type: string
      - in: query
        name: request
        schema: {}
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ReleaseMetadata'
          description: successful operation
      security:
      - apiKeyAuth: []
      summary: 'Deprecated: sinceVersion: 2024.1. Use ReleasesController.delete instead. Delete a release'
      tags:
      - Release management
    put:
      deprecated: true
      operationId: updateRelease
      parameters:
      - in: path
        name: cUUID
        required: true
        schema:
          format: uuid
          type: string
      - in: path
        name: name
        required: true
        schema:
          type: string
      - in: query
        name: request
        schema: {}
      requestBody:
        content:
          application/json:
            schema:
              type: object
        description: Release data to be updated
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ReleaseMetadata'
          description: successful operation
      security:
      - apiKeyAuth: []
      summary: 'Deprecated: sinceVersion: 2024.1. Use ReleasesController.update instead. Update a release'
      tags:
      - Release management
      x-codegen-request-body-name: Release
    servers:
    - url: /
components:
  schemas:
    GCSLocation:
      example:
        paths:
          x86_64: x86_64
          helmChart: helmChart
          helmChartChecksum: helmChartChecksum
          x86_64_checksum: x86_64_checksum
      properties:
        paths:
          $ref: '#/components/schemas/PackagePaths'
      type: object
    S3Location:
      example:
        paths:
          x86_64: x86_64
          helmChart: helmChart
          helmChartChecksum: helmChartChecksum
          x86_64_checksum: x86_64_checksum
      properties:
        paths:
          $ref: '#/components/schemas/PackagePaths'
      type: object
    HttpLocation:
      example:
        paths:
          x86_64: x86_64
          helmChart: helmChart
          helmChartChecksum: helmChartChecksum
          x86_64_checksum: x86_64_checksum
      properties:
        paths:
          $ref: '#/components/schemas/PackagePaths'
      type: object
    Package:
      example:
        path: path
        arch: x86_64
      properties:
        arch:
          enum:
          - x86_64
          - aarch64
          type: string
        path:
          type: string
      type: object
    PackagePaths:
      example:
        x86_64: x86_64
        helmChart: helmChart
        helmChartChecksum: helmChartChecksum
        x86_64_checksum: x86_64_checksum
      properties:
        helmChart:
          description: Path to the Helm chart package
          type: string
        helmChartChecksum:
          description: Checksum for the Helm chart package
          type: string
        x86_64:
          description: Path to x86_64 package
          type: string
        x86_64_checksum:
          description: Checksum for x86_64 package
          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
    ReleaseFormData:
      description: Specification for release locations
      example:
        s3:
          paths:
            x86_64: x86_64
            helmChart: helmChart
            helmChartChecksum: helmChartChecksum
            x86_64_checksum: x86_64_checksum
        gcs:
          paths:
            x86_64: x86_64
            helmChart: helmChart
            helmChartChecksum: helmChartChecksum
            x86_64_checksum: x86_64_checksum
        http:
          paths:
            x86_64: x86_64
            helmChart: helmChart
            helmChartChecksum: helmChartChecksum
            x86_64_checksum: x86_64_checksum
        version: version
      properties:
        gcs:
          $ref: '#/components/schemas/GCSLocation'
        http:
          $ref: '#/components/schemas/HttpLocation'
        s3:
          $ref: '#/components/schemas/S3Location'
        version:
          type: string
      required:
      - gcs
      - http
      - s3
      - version
      type: object
    ReleaseMetadata:
      description: Yugabyte release metadata
      example:
        s3:
          paths:
            x86_64: x86_64
            helmChart: helmChart
            helmChartChecksum: helmChartChecksum
            x86_64_checksum: x86_64_checksum
        notes:
        - notes
        - notes
        gcs:
          paths:
            x86_64: x86_64
            helmChart: helmChart
            helmChartChecksum: helmChartChecksum
            x86_64_checksum: x86_64_checksum
        filePath: filePath
        http:
          paths:
            x86_64: x86_64
            helmChart: helmChart
            helmChartChecksum: helmChartChecksum
            x86_64_checksum: x86_64_checksum
        state: ACTIVE
        imageTag: imageTag
        packages:
        - path: path
          arch: x86_64
        - path: path
          arch: x86_64
        chartPath: chartPath
      properties:
        chartPath:
          description: Helm chart path
          type: string
        filePath:
          description: Release file path
          type: string
        gcs:
          $ref: '#/components/schemas/GCSLocation'
        http:
          $ref: '#/components/schemas/HttpLocation'
        imageTag:
          description: Release image tag
          type: string
        notes:
          description: Release notes
          items:
            type: string
          type: array
        packages:
          description: Release packages
          items:
            $ref: '#/components/schemas/Package'
          type: array
        s3:
          $ref: '#/components/schemas/S3Location'
        state:
          description: Release state
          enum:
          - ACTIVE
          - DISABLED
          - DELETED
          example: ACTIVE
          type: string
      type: object
    GCSLocation_2:
      properties:
        paths:
          $ref: '#/components/schemas/PackagePaths_2'
          description: package paths
      type: object
    S3Location_2:
      properties:
        paths:
          $ref: '#/components/schemas/PackagePaths_2'
          description: package paths
      type: object
    HttpLocation_2:
      properties:
        paths:
          $ref: '#/components/schemas/PackagePaths_2'
          description: package paths
      type: object
    Package_2:
      properties:
        arch:
          enum:
          - x86_64
          - arm64
          type: string
        path:
          type: string
      type: object
    PackagePaths_2:
      properties:
        x86_64:
          description: Path to x86_64 package
          type: string
        x86_64_checksum:
          description: Checksum for x86_64 package
          type: string
      type: object
    ReleaseFormData_2:
      description: Specification for release locations
      properties:
        gcs:
          $ref: '#/components/schemas/GCSLocation_2'
        http:
          $ref: '#/components/schemas/HttpLocation_2'
        s3:
          $ref: '#/components/schemas/S3Location_2'
        version:
          type: string
      required:
      - gcs
      - http
      - s3
      - version
      type: object
    YBPSuccess_2:
      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
    ReleaseMetadata_2:
      description: Yugabyte release metadata
      properties:
        chartPath:
          description: Helm chart path
          type: string
        filePath:
          description: Release file path
          type: string
        gcs:
          $ref: '#/components/schemas/GCSLocation_2'
          description: GCS link and credentials
        http:
          $ref: '#/components/schemas/HttpLocation_2'
          description: HTTP link to the release
        imageTag:
          description: Release image tag
          type: string
        notes:
          description: Release notes
          items:
            type: string
          type: array
        packages:
          description: Release packages
          items:
            $ref: '#/components/schemas/Package_2'
          type: array
        s3:
          $ref: '#/components/schemas/S3Location_2'
          description: S3 link and credentials
        state:
          description: Release state
          enum:
          - ACTIVE
          - DISABLED
          - DELETED
          example: ACTIVE
          type: string
      type: object
    Package_3:
      example:
        path: path
        arch: x86_64
      properties:
        arch:
          enum:
          - x86_64
          - aarch64
          type: string
          example: x86_64
        path:
          type: string
          example: /var/lib/yugabyte/example
      type: object
    PackagePaths_3:
      example:
        x86_64: x86_64
        helmChart: helmChart
        helmChartChecksum: helmChartChecksum
        x86_64_checksum: x86_64_checksum
      properties:
        helmChart:
          description: Path to the Helm chart package
          type: string
          example: example-helmChart
        helmChartChecksum:
          description: Checksum for the Helm chart package
          type: string
          example: example-helmChartChecksum
        x86_64:
          description: Path to x86_64 package
          type: string
          example: example-x86_64
        x86_64_checksum:
          description: Checksum for x86_64 package
          type: string
          example: example-x86_64_checksum
      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
    ReleaseFormData_3:
      description: Specification for release locations
      example:
        s3:
          paths:
            x86_64: x86_64
            helmChart: helmChart
            helmChartChecksum: helmChartChecksum
            x86_64_checksum: x86_64_checksum
        gcs:
          paths:
            x86_64: x86_64
            helmChart: helmChart
            helmChartChecksum: helmChartChecksum
            x86_64_checksum: x86_64_checksum
        http:
          paths:
            x86_64: x86_64
            helmChart: helmChart
            helmChartChecksum: helmChartChecksum
            x86_64_checksum: x86_64_checksum
        version: version
      properties:
        gcs:
          $ref: '#/components/schemas/GCSLocation'
        http:
          $ref: '#/components/schemas/HttpLocation'
        s3:
          $ref: '#/components/schemas/S3Location'
        version:
          type: string
          example: 2.20.0.0
      required:
      - gcs
      - http
      - s3
      - version
      type: object
    ReleaseMetadata_3:
      description: Yugabyte release metadata
      example:
        s3:
          paths:
            x86_64: x86_64
            helmChart: helmChart
            helmChartChecksum: helmChartChecksum
            x86_64_checksum: x86_64_checksum
        notes:
        - notes
        - notes
        gcs:
          paths:
            x86_64: x86_64
            helmChart: helmChart
            helmChartChecksum: helmChartChecksum
            x86_64_checksum: x86_64_checksum
        filePath: filePath
        http:
          paths:
            x86_64: x86_64
            helmChart: helmChart
            helmChartChecksum: helmChartChecksum
            x86_64_checksum: x86_64_checksum
        state: ACTIVE
        imageTag: imageTag
        packages:
        - path: path
          arch: x86_64
        - path: path
          arch: x86_64
        chartPath: chartPath
      properties:
        chartPath:
          description: Helm chart path
          type: string
          example: /var/lib/yugabyte/example
        filePath:
          description: Release file path
          type: string
          example: /var/lib/yugabyte/example
        gcs:
          $ref: '#/components/schemas/GCSLocation'
        http:
          $ref: '#/components/schemas/HttpLocation'
        imageTag:
          description: Release image tag
          type: string
          example: example-tag
        notes:
          description: Release notes
          items:
            type: string
          type: array
          example:
          - example-notes
        packages:
          description: Release packages
          items:
            $ref: '#/components/schemas/Package_3'
          type: array
          example:
          - path: path
            arch: x86_64
        s3:
          $ref: '#/components/schemas/S3Location'
        state:
          description: Release state
          enum:
          - ACTIVE
          - DISABLED
          - DELETED
          example: ACTIVE
          type: string
      type: object
    Package_4:
      example:
        path: path
        arch: x86_64
      properties:
        arch:
          enum:
          - x86_64
          - aarch64
          type: string
          example: x86_64
        path:
          type: string
          example: /var/lib/yugabyte/example
      type: object
    PackagePaths_4:
      example:
        x86_64: x86_64
        helmChart: helmChart
        helmChartChecksum: helmChartChecksum
        x86_64_checksum: x86_64_checksum
      properties:
        helmChart:
          description: Path to the Helm chart package
          type: string
          example: example-helmChart
        helmChartChecksum:
          description: Checksum for the Helm chart package
          type: string
          example: example-helmChartChecksum
        x86_64:
          description: Path to x86_64 package
          type: string
          example: example-x86_64
        x86_64_checksum:
          description: Checksum for x86_64 package
          type: string
          example: example-x86_64_checksum
      type: object
    YBPSuccess_4:
      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
    ReleaseFormData_4:
      description: Specification for release locations
      example:
        s3:
          paths:
            x86_64: x86_64
            helmChart: helmChart
            helmChartChecksum: helmChartChecksum
            x86_64_checksum: x86_64_checksum
        gcs:
          paths:
            x86_64: x86_64
            helmChart: helmChart
            helmChartChecksum: helmChartChecksum
            x86_64_checksum: x86_64_checksum
        http:
          paths:
            x86_64: x86_64
            helmChart: helmChart
            helmChartChecksum: helmChartChecksum
            x86_64_checksum: x86_64_checksum
        version: version
      properties:
        gcs:
          $ref: '#/components/schemas/GCSLocation'
        http:
          $ref: '#/components/schemas/HttpLocation'
        s3:
          $ref: '#/components/schemas/S3Location'
        version:
          type: string
          example: 2.20.0.0
      required:
      - gcs
      - http
      - s3
      - version
      type: object
    ReleaseMetadata_4:
      description: Yugabyte release metadata
      example:
        s3:
          paths:
            x86_64: x86_64
            helmChart: helmChart
            helmChartChecksum: helmChartChecksum
            x86_64_checksum: x86_64_checksum
        notes:
        - notes
        - notes
        gcs:
          paths:
            x86_64: x86_64
            helmChart: helmChart
            helmChartChecksum: helmChartChecksum
            x86_64_checksum: x86_64_checksum
        filePath: filePath
        http:
          paths:
            x86_64: x86_64
            helmChart: helmChart
            helmChartChecksum: helmChartChecksum
            x86_64_checksum: x86_64_checksum
        state: ACTIVE
        imageTag: imageTag
        packages:
        - path: path
          arch: x86_64
        - path: path
          arch: x86_64
        chartPath: chartPath
      properties:
        chartPath:
          description: Helm chart path
          type: string
          example: /var/lib/yugabyte/example
        filePath:
          description: Release file path
          type: string
          example: /var/lib/yugabyte/example
        gcs:
          $ref: '#/components/schemas/GCSLocation'
        http:
          $ref: '#/components/schemas/HttpLocation'
        imageTag:
          description: Release image tag
          type: string
          example: example-tag
        notes:
          description: Release notes
          items:
            type: string
          type: array
          example:
          - example-notes
        packages:
          description: Release packages
          items:
            $ref: '#/components/schemas/Package_4'
          type: array
          example:
          - path: path
            arch: x86_64
        s3:
          $ref: '#/components/schemas/S3Location'
        state:
          description: Release state
          enum:
          - ACTIVE
          - DISABLED
          - DELETED
          example: ACTIVE
          type: string
      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
- platform.swagger.json
- yugabytedb-anywhere-v1-full.yaml
- yugabytedb-anywhere-v1-releases-maintenance.yaml