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

Yugabyte Preview API

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

Yugabyte Preview API is one of 82 APIs that Yugabyte publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Preview. 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 5 schemas. It is described by OpenAPI 3.2.0, at version v1.

Requests are made against a single base URL, /.

5 operations 2 paths 5 schemas 1 DELETE2 GET1 POST1 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

Yugabyte Preview 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 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.

Preview 5
GET
/api/v1/customers/{cUUID}/providers/{pUUID}/image_bundle
List image bundles
getListOfImageBundles 3 params → 200
POST
/api/v1/customers/{cUUID}/providers/{pUUID}/image_bundle
Create a image bundle
createImageBundle 3 params body → 200
DELETE
/api/v1/customers/{cUUID}/providers/{pUUID}/image_bundle/{iBUUID}
Delete a image bundle
delete 4 params → 200
GET
/api/v1/customers/{cUUID}/providers/{pUUID}/image_bundle/{iBUUID}
Get a image bundle
getImageBundle 3 params → 200
PUT
/api/v1/customers/{cUUID}/providers/{pUUID}/image_bundle/{iBUUID}
Update a image bundle
editImageBundle 4 params body → 200

Schemas 5

The contract defines 5 schemas that model the data the API accepts and returns. The most detailed are ImageBundle (6 properties), ImageBundleDetails (6 properties), BundleInfo (3 properties), YBPSuccess (2 properties). Each schema is shown below with its type and property counts.

Metadata
object
2 properties 2 required
ImageBundleDetails
object
6 properties
YBPSuccess
object
2 properties
ImageBundle
object
6 properties
BundleInfo
object
3 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

yugabyte-preview-api-openapi.yml Raw ↑

Other APIs Yugabyte publishes across the network.

YugabyteDB Aeon REST API
Yugabyte Backup Info API
Yugabyte Cluster API
Yugabyte Cluster Info API
Yugabyte Pitr Info API
Yugabyte Restore Info API
Yugabyte Voyager Info API
Yugabyte Voyager Metrics API
Yugabyte Xcluster Metrics API
Yugabyte Xcluster Namespace Details API
Yugabyte Access Keys API
Yugabyte Accounts API
Where this information came from

This is an independent, third-party profile of Yugabyte Preview 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.