Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

YugabyteDB New Release management API

The New Release management API from YugabyteDB — 2 operation(s) for new release management.

YugabyteDB New Release management API is one of 73 APIs that YugabyteDB publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include New Release management. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, a getting-started guide, and authentication docs.

This API exposes 5 operations across 2 paths, and defines 14 schemas. It is described by OpenAPI 3.1.0, at version v1.

Requests are made against a single base URL, https://cloud.yugabyte.com/api/public/v1.

5 operations 2 paths 14 schemas 1 DELETE2 GET1 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
v1
Base URL
https://cloud.yugabyte.com/api/public/v1
Authentication
HTTP Bearer
Terms of Service
Resource Areas
1

Authentication & Security 1

YugabyteDB New Release management API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (bearerAuth). By default, every request must be authenticated.

  • bearerAuth — API key obtained from the YugabyteDB Aeon UI under User Profile API Keys. Pass the key as a Bearer token in the Authorization header.

Paths & Operations 5

Across 2 paths, the API surfaces 5 operations — 1 DELETE, 2 GET, 1 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

New Release management 5
GET
/api/v1/customers/{cUUID}/ybdb_release
YugabyteDB Anywhere List Releases
listNewReleases 3 params → 200
POST
/api/v1/customers/{cUUID}/ybdb_release
YugabyteDB Anywhere Create a Release
createNewRelease 2 params body → 200
DELETE
/api/v1/customers/{cUUID}/ybdb_release/{rUUID}
YugabyteDB Anywhere Delete a Release
deleteNewRelease 3 params → 200
GET
/api/v1/customers/{cUUID}/ybdb_release/{rUUID}
YugabyteDB Anywhere Get a Release
getNewRelease 3 params → 200
PUT
/api/v1/customers/{cUUID}/ybdb_release/{rUUID}
YugabyteDB Anywhere Update a Release
updateNewRelease 3 params body → 200

Schemas 14

The contract defines 14 schemas that model the data the API accepts and returns. The most detailed are ResponseRelease_2 (10 properties), ResponseRelease (10 properties), CreateRelease (8 properties), CreateRelease_2 (8 properties). Each schema is shown below with its type and property counts.

UpdateRelease
object
Release metadata required to create a new release
5 properties 5 required
ResponseRelease
object
10 properties 10 required
Universe
object
3 properties 2 required
CreateRelease
object
Release metadata required to create a new release
8 properties 8 required
YBPSuccess
object
2 properties
YBPCreateSuccess
object
1 property
Artifact
object
5 properties 5 required
UpdateRelease_2
object
Release metadata required to create a new release
5 properties 5 required
ResponseRelease_2
object
10 properties 10 required
Universe_2
object
3 properties 2 required
CreateRelease_2
object
Release metadata required to create a new release
8 properties 8 required
YBPSuccess_2
object
2 properties
YBPCreateSuccess_2
object
1 property
Artifact_2
object
5 properties 5 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

yugabytedb-new-release-management-api-openapi.yml Raw ↑

Other APIs YugabyteDB publishes across the network.

YugabyteDB Access Keys API
YugabyteDB Accounts API
YugabyteDB Alerts API
YugabyteDB AllowLists API
YugabyteDB Asynchronous Replication API
YugabyteDB Audit API
YugabyteDB Authentication API
YugabyteDB Availability Zones API
YugabyteDB Backup and Restore API
YugabyteDB Backups API
YugabyteDB Certificate Info API
YugabyteDB Cloud providers API