YugabyteDB Support Bundle 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 Support Bundle 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
7 operations
across 5 paths,
and defines 12 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.
7 operations5 paths12 schemas1 DELETE4 GET2 POST
Metadata
The identity and technical contract details declared by the specification.
YugabyteDB Support Bundle 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 7
Across 5 paths, the API surfaces 7 operations — 1 DELETE, 4 GET, 2 POST. Each is listed below with its method, path, parameters, and response codes.
The contract defines 12 schemas that model the data the API accepts and returns. The most detailed are SupportBundleFormData (18 properties), SupportBundleFormData_2 (18 properties), BundleDetails_2 (11 properties), BundleDetails (11 properties). Each schema is shown below with its type and property counts.
SupportBundleSizeEstimateResponse
object
1 property
BundleDetails
object
11 properties1 required
YBPSuccess
object
2 properties
SupportBundle
object
10 properties5 required
SupportBundleFormData
object
Support bundle form metadata
18 properties3 required
YBPTask
object
2 properties
SupportBundleSizeEstimateResponse_2
object
1 property
BundleDetails_2
object
11 properties1 required
YBPSuccess_2
object
2 properties
SupportBundle_2
object
10 properties5 required
SupportBundleFormData_2
object
Support bundle form metadata
18 properties3 required
YBPTask_2
object
2 properties
Specification
The full machine-readable OpenAPI contract behind this narrative.
