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
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Need help?

Contact us
YugabyteDB

YugabyteDB Performance Advisor API

The Performance Advisor API from YugabyteDB — 9 operation(s) for performance advisor.

Documentation Provider Profile APIs.io OpenAPI GitHub

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 36 schemas. It is described by OpenAPI 3.2.0, at version v1.

Requests are made against a single base URL, /.

10 operations 9 paths 36 schemas 1 DELETE3 GET6 POST

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
License
Polyform Free Trial License 1.0.0
Terms of Service
View terms
Resource Areas
1

Authentication & Security 1

YugabyteDB Performance Advisor 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 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.

Performance Advisor 10
POST
/api/v1/customers/{cUUID}/performance_recommendation_state_change/page
List performance recommendations state change audit events (paginated)
pageAuditInfo 2 params body → 200
DELETE
/api/v1/customers/{cUUID}/performance_recommendations
Delete performance recommendations
delete 2 params body → 200
POST
/api/v1/customers/{cUUID}/performance_recommendations/hide
Hide performance recommendations
hide 2 params body → 200
POST
/api/v1/customers/{cUUID}/performance_recommendations/page
List performance recommendations (paginated)
page 2 params body → 200
POST
/api/v1/customers/{cUUID}/performance_recommendations/resolve
Resolve performance recommendations
resolve 2 params body → 200
GET
/api/v1/customers/{cUUID}/performance_recommendations/{rUUID}
Get performance recommendation details
get 2 params → 200
GET
/api/v1/customers/{cUUID}/universes/{uniUUID}/last_run
Get last performance advisor run details
getLatestRun 2 params → 200
GET
/api/v1/customers/{cUUID}/universes/{uniUUID}/perf_advisor_settings
Get universe performance advisor settings
getSettings 3 params → 200
POST
/api/v1/customers/{cUUID}/universes/{uniUUID}/perf_advisor_settings
Update universe performance advisor settings
updateSettings 3 params body → 200
POST
/api/v1/customers/{cUUID}/universes/{uniUUID}/start_manually
Start performance advisor run for universe
runPerfAdvisor 3 params → 200

Schemas 36

The contract defines 36 schemas that model the data the API accepts and returns. The most detailed are PerfAdvisorSettingsFormData (20 properties), PerfAdvisorSettingsFormData_3 (20 properties), PerfAdvisorSettingsFormData_2 (20 properties), PerformanceRecommendation (15 properties). Each schema is shown below with its type and property counts.

StateChangeAuditInfo
object
8 properties 8 required
StateChangeAuditInfoPagedResponse
object
4 properties 4 required
PerfAdvisorSettingsFormData
object
20 properties
PerfAdvisorSettingsWithDefaults
object
2 properties
StateChangeAuditInfoPagedQuery
object
6 properties 6 required
PerformanceRecommendationPagedResponse
object
4 properties 4 required
PerformanceRecommendationFilter
object
8 properties 8 required
PerformanceRecommendationPagedQuery
object
6 properties 6 required
PerformanceRecommendation
object
15 properties 15 required
StateChangeAuditInfoFilter
object
4 properties 4 required
PerfAdvisorManualRunStatus
object
3 properties
YBPSuccess
object
2 properties
Universe_performance_advisor_status
object
8 properties 4 required
StateChangeAuditInfo_2
object
8 properties 8 required
StateChangeAuditInfoPagedResponse_2
object
4 properties 4 required
PerfAdvisorSettingsFormData_2
object
20 properties
StateChangeAuditInfoPagedQuery_2
object
6 properties 6 required
PerformanceRecommendationPagedResponse_2
object
4 properties 4 required
PerformanceRecommendationPagedQuery_2
object
6 properties 6 required
PerformanceRecommendation_2
object
15 properties 15 required
StateChangeAuditInfoFilter_2
object
4 properties 4 required
PerfAdvisorManualRunStatus_2
object
3 properties
YBPSuccess_2
object
2 properties
PerformanceRecommendationFilter_2
object
8 properties 8 required
StateChangeAuditInfo_3
object
8 properties 8 required
StateChangeAuditInfoPagedResponse_3
object
4 properties 4 required
PerfAdvisorSettingsFormData_3
object
20 properties
StateChangeAuditInfoPagedQuery_3
object
6 properties 6 required
PerformanceRecommendationPagedResponse_3
object
4 properties 4 required
PerformanceRecommendationFilter_3
object
8 properties 8 required
PerformanceRecommendationPagedQuery_3
object
6 properties 6 required
PerformanceRecommendation_3
object
15 properties 15 required
StateChangeAuditInfoFilter_3
object
4 properties 4 required
PerfAdvisorManualRunStatus_3
object
3 properties
YBPSuccess_3
object
2 properties
Universe_performance_advisor_status_2
object
8 properties 4 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

yugabytedb-performance-advisor-api-openapi.yml Raw ↑

Other APIs YugabyteDB publishes across the network.

YugabyteDB Access Keys API
AE Profile APIs.io
YugabyteDB Accounts API
AE Profile APIs.io
YugabyteDB Alerts API
AE Profile APIs.io
YugabyteDB AllowLists API
AE Profile APIs.io
YugabyteDB Asynchronous Replication API
AE Profile APIs.io
YugabyteDB Audit API
AE Profile APIs.io
YugabyteDB Authentication API
AE Profile APIs.io
YugabyteDB Availability Zones API
AE Profile APIs.io
YugabyteDB Backup and Restore API
AE Profile APIs.io
YugabyteDB Backups API
AE Profile APIs.io
YugabyteDB Certificate Info API
AE Profile APIs.io
YugabyteDB Cloud providers API
AE Profile APIs.io
#Performance Advisor
← Back to Y APIs
API Details
ID
yugabytedb:yugabytedb-performance-advisor-api
Base URL
https://cloud.yugabyte.com/api/public/v1
Docs
https://docs.yugabyte.com/stable/yugabyte-cloud/managed-automation/managed-api/
Provider
YugabyteDB
APIs.io →  GitHub →
Explore more
All APIs Providers APIs.io Network
Work with this as data

Every API here is available over the API and to AI agents over MCP. APIs is not yet its own endpoint on the v1 API. Reach this content through network search and the tag graph, or the MCP server below.

Installs https://mcp.apievangelist.com/mcp in Claude, Cursor, VS Code and the rest — one button, every client.

MCP tools for apis
4 tools reach this content
  • search_api_evangelistSearch every content type across the network at once.
  • find_relatedThe shared-tag relevance graph — what else covers this.
  • get_tagEverything one tag labels, across all content types.
  • guide_topicPRO — a curated bundle for a topic: area, guidance, rules, papers, stories, services.
All tools & prompts
Call it yourself
curl for this page
Search the network for this 
curl "https://api.apievangelist.com/v1/search?q=yugabytedb-performance-advisor-api&limit=10"
Everything under a tag 
curl "https://api.apievangelist.com/v1/tags/yugabytedb-performance-advisor-api"

Discovery needs no key. Full bodies and the synthesis endpoints are Pro.

Get an API key

Free tier, no email required. Sign in with whichever identity you already have.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have. Your account

Where this information came from

This is an independent, third-party profile of YugabyteDB Performance Advisor 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.