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 PA Collector API

The PA Collector API from Yugabyte — 4 operation(s) for pa collector.

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

Tagged areas include PA Collector. 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 8 operations across 4 paths, and defines 4 schemas. It is described by OpenAPI 3.2.0, at version v1.

Requests are made against a single base URL, /.

8 operations 4 paths 4 schemas 2 DELETE3 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

Yugabyte PA Collector 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 8

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

PA Collector 8
GET
/api/v1/customers/{cUUID}/pa_collector
List All PA Collectors
listAllPACollectors 1 param → 200
POST
/api/v1/customers/{cUUID}/pa_collector
Create PA Collector
createPACollector 2 params body → 200
DELETE
/api/v1/customers/{cUUID}/pa_collector/{paUUID}
Delete PA Collector
deletePACollector 4 params → 200
GET
/api/v1/customers/{cUUID}/pa_collector/{paUUID}
Get PA Collector
getPACollector 2 params → 200
PUT
/api/v1/customers/{cUUID}/pa_collector/{paUUID}
Edit PA Collector
editPACollector 4 params body → 200
DELETE
/api/v1/customers/{cUUID}/universes/{uUUID}/pa_collector
Unregister universe from PA Collector
unregisterUniverse 3 params → 200
GET
/api/v1/customers/{cUUID}/universes/{uUUID}/pa_collector
Check if universe is registered with PA Collector
checkRegistered 2 params → 200
PUT
/api/v1/customers/{cUUID}/universes/{uUUID}/pa_collector/{paUUID}
Register universe with PA Collector
registerUniverse 5 params → 200

Schemas 4

The contract defines 4 schemas that model the data the API accepts and returns. The most detailed are PA_Collector_Details_Model (11 properties), PACollector (10 properties), YBPSuccess (2 properties), PA_Collector_universe_registration_status (2 properties). Each schema is shown below with its type and property counts.

PACollector
object
Performance Advisor Collector Model
10 properties 7 required
PA_Collector_universe_registration_status
object
2 properties
YBPSuccess
object
2 properties
PA_Collector_Details_Model
object
11 properties 7 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

yugabyte-pa-collector-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 PA Collector 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.