YugabyteDB Performance Advisor API
The Performance Advisor API from YugabyteDB — 9 operation(s) for performance advisor.
YugabyteDB Performance Advisor API is one of 73 APIs that YugabyteDB publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include Performance Advisor. 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 10 operations across 9 paths, and defines 25 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.
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 1
YugabyteDB Performance Advisor 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 10
Across 9 paths, the API surfaces 10 operations — 1 DELETE, 3 GET, 6 POST. Each is listed below with its method, path, parameters, and response codes.
Schemas 25
The contract defines 25 schemas that model the data the API accepts and returns. The most detailed are PerfAdvisorSettingsFormData (20 properties), PerfAdvisorSettingsFormData_2 (20 properties), PerformanceRecommendation (15 properties), PerformanceRecommendation_2 (15 properties). Each schema is shown below with its type and property counts.
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from YugabyteDB 12
Other APIs YugabyteDB publishes across the network.