Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

YugabyteDB PA Collector API

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

YugabyteDB PA Collector API is one of 73 APIs that YugabyteDB 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 8 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.

8 operations 4 paths 8 schemas 2 DELETE3 GET1 POST2 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
v1
Base URL
https://cloud.yugabyte.com/api/public/v1
Authentication
HTTP Bearer
Terms of Service
Resource Areas
1

Authentication & Security 1

YugabyteDB PA Collector 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 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
YugabyteDB Anywhere List All PA Collectors
listAllPACollectors 1 param → 200
POST
/api/v1/customers/{cUUID}/pa_collector
YugabyteDB Anywhere Create PA Collector
createPACollector 2 params body → 200
DELETE
/api/v1/customers/{cUUID}/pa_collector/{paUUID}
YugabyteDB Anywhere Delete PA Collector
deletePACollector 4 params → 200
GET
/api/v1/customers/{cUUID}/pa_collector/{paUUID}
YugabyteDB Anywhere Get PA Collector
getPACollector 2 params → 200
PUT
/api/v1/customers/{cUUID}/pa_collector/{paUUID}
YugabyteDB Anywhere Edit PA Collector
editPACollector 4 params body → 200
DELETE
/api/v1/customers/{cUUID}/universes/{uUUID}/pa_collector
YugabyteDB Anywhere Unregister Universe from PA Collector
unregisterUniverse 3 params → 200
GET
/api/v1/customers/{cUUID}/universes/{uUUID}/pa_collector
YugabyteDB Anywhere Check if Universe is Registered with PA Collector
checkRegistered 2 params → 200
PUT
/api/v1/customers/{cUUID}/universes/{uUUID}/pa_collector/{paUUID}
YugabyteDB Anywhere Register Universe with PA Collector
registerUniverse 5 params → 200

Schemas 8

The contract defines 8 schemas that model the data the API accepts and returns. The most detailed are PA Collector Details Model (11 properties), PA Collector Details Model_2 (11 properties), PACollector (10 properties), PACollector_2 (10 properties). Each schema is shown below with its type and property counts.

PACollector
object
Performance Advisor Collector Model
10 properties 7 required
YBPSuccess
object
2 properties
PA Collector Details Model
object
11 properties 7 required
PA Collector universe registration status
object
2 properties
PACollector_2
object
Performance Advisor Collector Model
10 properties 7 required
YBPSuccess_2
object
2 properties
PA Collector Details Model_2
object
11 properties 7 required
PA Collector universe registration status_2
object
2 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

yugabytedb-pa-collector-api-openapi.yml Raw ↑

Other APIs YugabyteDB publishes across the network.

YugabyteDB Access Keys API
YugabyteDB Accounts API
YugabyteDB Alerts API
YugabyteDB AllowLists API
YugabyteDB Asynchronous Replication API
YugabyteDB Audit API
YugabyteDB Authentication API
YugabyteDB Availability Zones API
YugabyteDB Backup and Restore API
YugabyteDB Backups API
YugabyteDB Certificate Info API
YugabyteDB Cloud providers API