How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

YugabyteDB Release management API

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

This API exposes 6 operations across 3 paths, and defines 16 schemas. It is described by OpenAPI 3.2.0, at version v1.

Requests are made against a single base URL, /.

6 operations 3 paths 16 schemas 1 DELETE2 GET1 POST2 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
v1
Base URL
https://cloud.yugabyte.com/api/public/v1
Authentication
API Key
Contact
https://docs.yugabyte.com
Terms of Service
Resource Areas
1

Authentication & Security 1

YugabyteDB Release management API declares 1 security scheme for authenticating requests. An API key is passed in the header as X-AUTH-YW-API-TOKEN (apiKeyAuth).

  • apiKeyAuth — API token passed as header

Paths & Operations 6

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

Release management 6
GET
/api/v1/customers/{cUUID}/providers/{pUUID}/releasesdeprecated
List releases by provider - deprecated
getListOfRegionReleases 3 params → 200
GET
/api/v1/customers/{cUUID}/releasesdeprecated
Deprecated: sinceVersion: 2024.1.
getListOfReleases 3 params → 200
POST
/api/v1/customers/{cUUID}/releasesdeprecated
Deprecated: sinceVersion 2024.1.
createRelease 2 params body → 200
PUT
/api/v1/customers/{cUUID}/releases
Refresh a release
refresh 2 params → 200
DELETE
/api/v1/customers/{cUUID}/releases/{name}deprecated
Deprecated: sinceVersion: 2024.1.
deleteRelease 3 params → 200
PUT
/api/v1/customers/{cUUID}/releases/{name}deprecated
Deprecated: sinceVersion: 2024.1.
updateRelease 3 params body → 200

Schemas 16

The contract defines 16 schemas that model the data the API accepts and returns. The most detailed are ReleaseMetadata (9 properties), ReleaseMetadata_2 (9 properties), ReleaseFormData (4 properties), PackagePaths (4 properties). Each schema is shown below with its type and property counts.

ReleaseFormData
object
Specification for release locations
4 properties 4 required
S3Location
object
1 property
PackagePaths
object
4 properties
HttpLocation
object
1 property
GCSLocation
object
1 property
ReleaseMetadata
object
Yugabyte release metadata
9 properties
YBPSuccess
object
2 properties
Package
object
2 properties
ReleaseFormData_2
object
Specification for release locations
4 properties 4 required
S3Location_2
object
1 property
PackagePaths_2
object
2 properties
HttpLocation_2
object
1 property
GCSLocation_2
object
1 property
ReleaseMetadata_2
object
Yugabyte release metadata
9 properties
YBPSuccess_2
object
2 properties
Package_2
object
2 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

yugabytedb-release-management-api-openapi.yml Raw ↑
Where this information came from

This is an independent, third-party profile of YugabyteDB Release management API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.