YugabyteDB

YugabyteDB PA Collector API

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

Documentation GitHub OpenAPI

Operations 8

GET /api/v1/customers/{cUUID}/pa_collector List All PA Collectors #

POST /api/v1/customers/{cUUID}/pa_collector Create PA Collector #

DELETE /api/v1/customers/{cUUID}/pa_collector/{paUUID} Delete PA Collector #

GET /api/v1/customers/{cUUID}/pa_collector/{paUUID} Get PA Collector #

PUT /api/v1/customers/{cUUID}/pa_collector/{paUUID} Edit PA Collector #

DELETE /api/v1/customers/{cUUID}/universes/{uUUID}/pa_collector Unregister universe from PA Collector #

GET /api/v1/customers/{cUUID}/universes/{uUUID}/pa_collector Check if universe is registered with PA Collector #

PUT /api/v1/customers/{cUUID}/universes/{uUUID}/pa_collector/{paUUID} Register universe with PA Collector #

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this

find_apisBrowse and filter every API in the catalog.
get_api_artifactsOne API's artifacts, grouped by type.
get_openapiThe primary OpenAPI for this API.
find_similar_apisAPIs that look like this one.
apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
resolveTurn a domain, URL or GitHub org into the provider it belongs to.
find_cohortsEvery scored population of providers in the catalog.

All 92 tools →

Call it yourself

curl for this page

This API

curl "https://apis.io/api/v1/apis/yugabytedb-pa-collector-api"

All apis

curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

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

OpenAPI Specification

openapi: 3.2.0
info:
  title: Yugabytedb PA Collector API
  version: v1
  contact:
    name: https://docs.yugabyte.com
  license:
    name: Polyform Free Trial License 1.0.0
    url: https://github.com/yugabyte/yugabyte-db/blob/master/licenses/POLYFORM-FREE-TRIAL-LICENSE-1.0.0.txt
  termsOfService: TODO(chirag)
  x-refined-note:
  - x-source differs across the merged source definitions and was not carried
  - x-split-from differs across the merged source definitions and was not carried
  description: 'Operations tagged PA Collector across 3 of this provider''s published API definitions: openapi_2.yaml, yugabytedb-anywhere-v1-alerts-monitoring.yaml, yugabytedb-anywhere-v1-full.yaml. Each path carries the servers of the definition it was published in.'
servers:
- url: /
tags:
- name: PA Collector
paths:
  /api/v1/customers/{cUUID}/pa_collector:
    get:
      description: YbaApi Internal.
      operationId: listAllPACollectors
      parameters:
      - in: path
        name: cUUID
        required: true
        schema:
          format: uuid
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/PA_Collector_Details_Model'
                type: array
          description: successful operation
      security:
      - apiKeyAuth: []
      summary: List All PA Collectors
      tags:
      - PA Collector
    post:
      description: YbaApi Internal.
      operationId: createPACollector
      parameters:
      - in: path
        name: cUUID
        required: true
        schema:
          format: uuid
          type: string
      - in: query
        name: request
        schema: {}
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PACollector'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PACollector'
          description: successful operation
      security:
      - apiKeyAuth: []
      summary: Create PA Collector
      tags:
      - PA Collector
      x-codegen-request-body-name: collectorData
    servers:
    - url: /
  /api/v1/customers/{cUUID}/pa_collector/{paUUID}:
    delete:
      description: YbaApi Internal.
      operationId: deletePACollector
      parameters:
      - in: path
        name: cUUID
        required: true
        schema:
          format: uuid
          type: string
      - in: path
        name: paUUID
        required: true
        schema:
          format: uuid
          type: string
      - in: query
        name: force
        schema:
          default: false
          type: boolean
      - in: query
        name: request
        schema: {}
      responses:
        '200':
          content:
            application/json:
              schema:
                type: boolean
          description: successful operation
      security:
      - apiKeyAuth: []
      summary: Delete PA Collector
      tags:
      - PA Collector
    get:
      description: YbaApi Internal.
      operationId: getPACollector
      parameters:
      - in: path
        name: cUUID
        required: true
        schema:
          format: uuid
          type: string
      - in: path
        name: paUUID
        required: true
        schema:
          format: uuid
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PA_Collector_Details_Model'
          description: successful operation
      security:
      - apiKeyAuth: []
      summary: Get PA Collector
      tags:
      - PA Collector
    put:
      description: YbaApi Internal.
      operationId: editPACollector
      parameters:
      - in: path
        name: cUUID
        required: true
        schema:
          format: uuid
          type: string
      - in: path
        name: paUUID
        required: true
        schema:
          format: uuid
          type: string
      - in: query
        name: force
        schema:
          default: false
          type: boolean
      - in: query
        name: request
        schema: {}
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PACollector'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PACollector'
          description: successful operation
      security:
      - apiKeyAuth: []
      summary: Edit PA Collector
      tags:
      - PA Collector
      x-codegen-request-body-name: collectorData
    servers:
    - url: /
  /api/v1/customers/{cUUID}/universes/{uUUID}/pa_collector:
    delete:
      description: YbaApi Internal.
      operationId: unregisterUniverse
      parameters:
      - in: path
        name: cUUID
        required: true
        schema:
          format: uuid
          type: string
      - in: path
        name: uUUID
        required: true
        schema:
          format: uuid
          type: string
      - in: query
        name: request
        schema: {}
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/YBPSuccess'
          description: successful operation
      security:
      - apiKeyAuth: []
      summary: Unregister universe from PA Collector
      tags:
      - PA Collector
    get:
      description: YbaApi Internal.
      operationId: checkRegistered
      parameters:
      - in: path
        name: cUUID
        required: true
        schema:
          format: uuid
          type: string
      - in: path
        name: uUUID
        required: true
        schema:
          format: uuid
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PA_Collector_universe_registration_status'
          description: successful operation
      security:
      - apiKeyAuth: []
      summary: Check if universe is registered with PA Collector
      tags:
      - PA Collector
    servers:
    - url: /
  /api/v1/customers/{cUUID}/universes/{uUUID}/pa_collector/{paUUID}:
    put:
      description: YbaApi Internal.
      operationId: registerUniverse
      parameters:
      - in: path
        name: cUUID
        required: true
        schema:
          format: uuid
          type: string
      - in: path
        name: uUUID
        required: true
        schema:
          format: uuid
          type: string
      - in: path
        name: paUUID
        required: true
        schema:
          format: uuid
          type: string
      - in: query
        name: advancedObservability
        schema:
          default: false
          type: boolean
      - in: query
        name: request
        schema: {}
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/YBPSuccess'
          description: successful operation
      security:
      - apiKeyAuth: []
      summary: Register universe with PA Collector
      tags:
      - PA Collector
    servers:
    - url: /
components:
  schemas:
    PA_Collector_Details_Model:
      example:
        inUseStatus: IN_USE
        apiToken: apiToken
        customerUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
        metricsPassword: metricsPassword
        metricsUsername: metricsUsername
        metricsUrl: metricsUrl
        paApiToken: paApiToken
        paUrl: paUrl
        ybaUrl: ybaUrl
        metricsScrapePeriodSecs: 0
        uuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
      properties:
        apiToken:
          description: YBA API Token
          type: string
        customerUUID:
          description: Customer UUID
          format: uuid
          readOnly: true
          type: string
        inUseStatus:
          description: In Use Status
          enum:
          - IN_USE
          - NOT_IN_USE
          - ERROR
          type: string
        metricsPassword:
          description: Metrics API Password
          type: string
        metricsScrapePeriodSecs:
          description: Metrics Scrape Period Seconds
          format: int64
          type: integer
        metricsUrl:
          description: Metrics URL
          type: string
        metricsUsername:
          description: Metrics API Username
          type: string
        paApiToken:
          description: PA Collector API Token
          type: string
        paUrl:
          description: PA Collector URL
          type: string
        uuid:
          description: PA Collector UUID
          format: uuid
          readOnly: true
          type: string
        ybaUrl:
          description: YBA URL
          type: string
      required:
      - apiToken
      - customerUUID
      - metricsScrapePeriodSecs
      - metricsUrl
      - paUrl
      - uuid
      - ybaUrl
      type: object
    PACollector:
      description: Performance Advisor Collector Model
      example:
        apiToken: apiToken
        customerUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
        metricsPassword: metricsPassword
        metricsUsername: metricsUsername
        metricsUrl: metricsUrl
        paApiToken: paApiToken
        paUrl: paUrl
        ybaUrl: ybaUrl
        metricsScrapePeriodSecs: 0
        uuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
      properties:
        apiToken:
          description: YBA API Token
          type: string
        customerUUID:
          description: Customer UUID
          format: uuid
          readOnly: true
          type: string
        metricsPassword:
          description: Metrics API Password
          type: string
        metricsScrapePeriodSecs:
          description: Metrics Scrape Period Seconds
          format: int64
          type: integer
        metricsUrl:
          description: Metrics URL
          type: string
        metricsUsername:
          description: Metrics API Username
          type: string
        paApiToken:
          description: PA Collector API Token
          type: string
        paUrl:
          description: PA Collector URL
          type: string
        uuid:
          description: PA Collector UUID
          format: uuid
          readOnly: true
          type: string
        ybaUrl:
          description: YBA URL
          type: string
      required:
      - apiToken
      - customerUUID
      - metricsScrapePeriodSecs
      - metricsUrl
      - paUrl
      - uuid
      - ybaUrl
      type: object
    YBPSuccess:
      example:
        success: true
        message: message
      properties:
        message:
          description: API response message.
          readOnly: true
          type: string
        success:
          description: API operation status. A value of true indicates the operation was successful.
          readOnly: true
          type: boolean
      type: object
    PA_Collector_universe_registration_status:
      example:
        success: true
        advancedObservability: true
      properties:
        advancedObservability:
          description: Whether advanced observability (metrics export to Prometheus) is enabled
          type: boolean
        success:
          description: Whether the universe is registered with PA Collector
          type: boolean
      type: object
    PACollector_2:
      description: Performance Advisor Collector Model
      example:
        apiToken: apiToken
        customerUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
        metricsPassword: metricsPassword
        metricsUsername: metricsUsername
        metricsUrl: metricsUrl
        paApiToken: paApiToken
        paUrl: paUrl
        ybaUrl: ybaUrl
        metricsScrapePeriodSecs: 0
        uuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
      properties:
        apiToken:
          description: YBA API Token
          type: string
          example: REDACTED
        customerUUID:
          description: Customer UUID
          format: uuid
          readOnly: true
          type: string
          example: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
        metricsPassword:
          description: Metrics API Password
          type: string
          example: REDACTED
        metricsScrapePeriodSecs:
          description: Metrics Scrape Period Seconds
          format: int64
          type: integer
          example: 1000
        metricsUrl:
          description: Metrics URL
          type: string
          example: https://example.com
        metricsUsername:
          description: Metrics API Username
          type: string
          example: example-metricsUsername
        paApiToken:
          description: PA Collector API Token
          type: string
          example: REDACTED
        paUrl:
          description: PA Collector URL
          type: string
          example: https://example.com
        uuid:
          description: PA Collector UUID
          format: uuid
          readOnly: true
          type: string
          example: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
        ybaUrl:
          description: YBA URL
          type: string
          example: https://example.com
      required:
      - apiToken
      - customerUUID
      - metricsScrapePeriodSecs
      - metricsUrl
      - paUrl
      - uuid
      - ybaUrl
      type: object
    YBPSuccess_2:
      example:
        success: true
        message: message
      properties:
        message:
          description: API response message.
          readOnly: true
          type: string
          example: Example message
        success:
          description: API operation status. A value of true indicates the operation was successful.
          readOnly: true
          type: boolean
          example: true
      type: object
    PA_Collector_Details_Model_2:
      example:
        inUseStatus: IN_USE
        apiToken: apiToken
        customerUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
        metricsPassword: metricsPassword
        metricsUsername: metricsUsername
        metricsUrl: metricsUrl
        paApiToken: paApiToken
        paUrl: paUrl
        ybaUrl: ybaUrl
        metricsScrapePeriodSecs: 0
        uuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
      properties:
        apiToken:
          description: YBA API Token
          type: string
          example: REDACTED
        customerUUID:
          description: Customer UUID
          format: uuid
          readOnly: true
          type: string
          example: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
        inUseStatus:
          description: In Use Status
          enum:
          - IN_USE
          - NOT_IN_USE
          - ERROR
          type: string
          example: IN_USE
        metricsPassword:
          description: Metrics API Password
          type: string
          example: REDACTED
        metricsScrapePeriodSecs:
          description: Metrics Scrape Period Seconds
          format: int64
          type: integer
          example: 1000
        metricsUrl:
          description: Metrics URL
          type: string
          example: https://example.com
        metricsUsername:
          description: Metrics API Username
          type: string
          example: example-metricsUsername
        paApiToken:
          description: PA Collector API Token
          type: string
          example: REDACTED
        paUrl:
          description: PA Collector URL
          type: string
          example: https://example.com
        uuid:
          description: PA Collector UUID
          format: uuid
          readOnly: true
          type: string
          example: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
        ybaUrl:
          description: YBA URL
          type: string
          example: https://example.com
      required:
      - apiToken
      - customerUUID
      - metricsScrapePeriodSecs
      - metricsUrl
      - paUrl
      - uuid
      - ybaUrl
      type: object
    PACollector_3:
      description: Performance Advisor Collector Model
      example:
        apiToken: apiToken
        customerUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
        metricsPassword: metricsPassword
        metricsUsername: metricsUsername
        metricsUrl: metricsUrl
        paApiToken: paApiToken
        paUrl: paUrl
        ybaUrl: ybaUrl
        metricsScrapePeriodSecs: 0
        uuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
      properties:
        apiToken:
          description: YBA API Token
          type: string
          example: REDACTED
        customerUUID:
          description: Customer UUID
          format: uuid
          readOnly: true
          type: string
          example: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
        metricsPassword:
          description: Metrics API Password
          type: string
          example: REDACTED
        metricsScrapePeriodSecs:
          description: Metrics Scrape Period Seconds
          format: int64
          type: integer
          example: 1000
        metricsUrl:
          description: Metrics URL
          type: string
          example: https://example.com
        metricsUsername:
          description: Metrics API Username
          type: string
          example: example-metricsUsername
        paApiToken:
          description: PA Collector API Token
          type: string
          example: REDACTED
        paUrl:
          description: PA Collector URL
          type: string
          example: https://example.com
        uuid:
          description: PA Collector UUID
          format: uuid
          readOnly: true
          type: string
          example: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
        ybaUrl:
          description: YBA URL
          type: string
          example: https://example.com
      required:
      - apiToken
      - customerUUID
      - metricsScrapePeriodSecs
      - metricsUrl
      - paUrl
      - uuid
      - ybaUrl
      type: object
    YBPSuccess_3:
      example:
        success: true
        message: message
      properties:
        message:
          description: API response message.
          readOnly: true
          type: string
          example: Example message
        success:
          description: API operation status. A value of true indicates the operation was successful.
          readOnly: true
          type: boolean
          example: true
      type: object
    PA_Collector_universe_registration_status_2:
      example:
        success: true
        advancedObservability: true
      properties:
        advancedObservability:
          description: Whether advanced observability (metrics export to Prometheus) is enabled
          type: boolean
          example: true
        success:
          description: Whether the universe is registered with PA Collector
          type: boolean
          example: true
      type: object
  securitySchemes:
    apiKeyAuth:
      description: API token passed as header
      in: header
      name: X-AUTH-YW-API-TOKEN
      type: apiKey
externalDocs:
  description: About YugabyteDB Anywhere
  url: https://docs.yugabyte.com/latest/yugabyte-platform/
x-refined-from:
- openapi_2.yaml
- yugabytedb-anywhere-v1-alerts-monitoring.yaml
- yugabytedb-anywhere-v1-full.yaml