YugabyteDB Universe performance suggestions API

The Universe performance suggestions API from YugabyteDB — 3 operation(s) for universe performance suggestions.

Documentation GitHub OpenAPI

Operations 3

GET /api/v1/customers/{cUUID}/universes/{uniUUID}/query_distribution_suggestions Get query distribution improvement suggestion for a universe #

GET /api/v1/customers/{cUUID}/universes/{uniUUID}/range_hash Return list of hash indexes #

GET /api/v1/customers/{cUUID}/universes/{uniUUID}/unused_indexes Return list of each unused index across the universe #

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-universe-performance-suggestions-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 Universe performance suggestions 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 Universe performance suggestions across 3 of this provider''s published API definitions: openapi_2.yaml, yugabytedb-anywhere-v1-full.yaml, yugabytedb-anywhere-v1-universes.yaml. Each path carries the servers of the definition it was published in.'
servers:
- url: /
tags:
- name: Universe performance suggestions
paths:
  /api/v1/customers/{cUUID}/universes/{uniUUID}/query_distribution_suggestions:
    get:
      description: 'WARNING: This is a preview API that could change.'
      operationId: getQueryDistributionSuggestions
      parameters:
      - in: path
        name: cUUID
        required: true
        schema:
          format: uuid
          type: string
      - in: path
        name: uniUUID
        required: true
        schema:
          format: uuid
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/QueryDistributionSuggestionResponse'
          description: successful operation
      security:
      - apiKeyAuth: []
      summary: Get query distribution improvement suggestion for a universe
      tags:
      - Universe performance suggestions
    servers:
    - url: /
  /api/v1/customers/{cUUID}/universes/{uniUUID}/range_hash:
    get:
      description: 'WARNING: This is a preview API that could change. Returns list of hash indexes on timestamp columns.'
      operationId: getRangeHash
      parameters:
      - in: path
        name: cUUID
        required: true
        schema:
          format: uuid
          type: string
      - in: path
        name: uniUUID
        required: true
        schema:
          format: uuid
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HashedTimestampColumnFinderResponse'
          description: successful operation
      security:
      - apiKeyAuth: []
      summary: Return list of hash indexes
      tags:
      - Universe performance suggestions
    servers:
    - url: /
  /api/v1/customers/{cUUID}/universes/{uniUUID}/unused_indexes:
    get:
      description: 'WARNING: This is a preview API that could change. Returns list of unused indexes, along with their database and table.'
      operationId: getUnusedIndexes
      parameters:
      - in: path
        name: cUUID
        required: true
        schema:
          format: uuid
          type: string
      - in: path
        name: uniUUID
        required: true
        schema:
          format: uuid
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UnusedIndexFinderResponse'
          description: successful operation
      security:
      - apiKeyAuth: []
      summary: Return list of each unused index across the universe
      tags:
      - Universe performance suggestions
    servers:
    - url: /
components:
  schemas:
    UnusedIndexFinderResponse:
      example:
        index_command: index_command
        description: description
        current_database: current_database
        index_name: index_name
        table_name: table_name
      properties:
        current_database:
          type: string
        description:
          type: string
        index_command:
          type: string
        index_name:
          type: string
        table_name:
          type: string
      type: object
    HashedTimestampColumnFinderResponse:
      example:
        index_command: index_command
        description: description
        current_database: current_database
        index_name: index_name
        table_name: table_name
      properties:
        current_database:
          type: string
        description:
          type: string
        index_command:
          type: string
        index_name:
          type: string
        table_name:
          type: string
      type: object
    QueryDistributionSuggestionResponse:
      example:
        suggestion: suggestion
        description: description
        details:
        - node: node
          numInsert: 6
          numDelete: 0
          numUpdate: 5
          numSelect: 1
        - node: node
          numInsert: 6
          numDelete: 0
          numUpdate: 5
          numSelect: 1
        startTime: startTime
        endTime: endTime
        adviceType: adviceType
      properties:
        adviceType:
          type: string
        description:
          type: string
        details:
          items:
            $ref: '#/components/schemas/NodeQueryDistributionDetails'
          type: array
        endTime:
          type: string
        startTime:
          type: string
        suggestion:
          type: string
      required:
      - adviceType
      - description
      - details
      - endTime
      - startTime
      - suggestion
      type: object
    NodeQueryDistributionDetails:
      example:
        node: node
        numInsert: 6
        numDelete: 0
        numUpdate: 5
        numSelect: 1
      properties:
        node:
          type: string
        numDelete:
          format: int32
          type: integer
        numInsert:
          format: int32
          type: integer
        numSelect:
          format: int32
          type: integer
        numUpdate:
          format: int32
          type: integer
      required:
      - node
      - numDelete
      - numInsert
      - numSelect
      - numUpdate
      type: object
    UnusedIndexFinderResponse_2:
      example:
        index_command: index_command
        description: description
        current_database: current_database
        index_name: index_name
        table_name: table_name
      properties:
        current_database:
          type: string
          example: example-current_database
        description:
          type: string
          example: Example description
        index_command:
          type: string
          example: example-index_command
        index_name:
          type: string
          example: example-index_name
        table_name:
          type: string
          example: example-table_name
      type: object
    HashedTimestampColumnFinderResponse_2:
      example:
        index_command: index_command
        description: description
        current_database: current_database
        index_name: index_name
        table_name: table_name
      properties:
        current_database:
          type: string
          example: example-current_database
        description:
          type: string
          example: Example description
        index_command:
          type: string
          example: example-index_command
        index_name:
          type: string
          example: example-index_name
        table_name:
          type: string
          example: example-table_name
      type: object
    QueryDistributionSuggestionResponse_2:
      example:
        suggestion: suggestion
        description: description
        details:
        - node: node
          numInsert: 6
          numDelete: 0
          numUpdate: 5
          numSelect: 1
        - node: node
          numInsert: 6
          numDelete: 0
          numUpdate: 5
          numSelect: 1
        startTime: startTime
        endTime: endTime
        adviceType: adviceType
      properties:
        adviceType:
          type: string
          example: DEFAULT
        description:
          type: string
          example: Example description
        details:
          items:
            $ref: '#/components/schemas/NodeQueryDistributionDetails_2'
          type: array
          example:
          - node: node
            numInsert: 6
            numDelete: 0
            numUpdate: 5
            numSelect: 1
        endTime:
          type: string
          example: '2026-05-03T12:00:00Z'
        startTime:
          type: string
          example: '2026-05-03T12:00:00Z'
        suggestion:
          type: string
          example: example-suggestion
      required:
      - adviceType
      - description
      - details
      - endTime
      - startTime
      - suggestion
      type: object
    NodeQueryDistributionDetails_2:
      example:
        node: node
        numInsert: 6
        numDelete: 0
        numUpdate: 5
        numSelect: 1
      properties:
        node:
          type: string
          example: node-1
        numDelete:
          format: int32
          type: integer
          example: 10
        numInsert:
          format: int32
          type: integer
          example: 10
        numSelect:
          format: int32
          type: integer
          example: 10
        numUpdate:
          format: int32
          type: integer
          example: 10
      required:
      - node
      - numDelete
      - numInsert
      - numSelect
      - numUpdate
      type: object
    UnusedIndexFinderResponse_3:
      example:
        index_command: index_command
        description: description
        current_database: current_database
        index_name: index_name
        table_name: table_name
      properties:
        current_database:
          type: string
          example: example-current_database
        description:
          type: string
          example: Example description
        index_command:
          type: string
          example: example-index_command
        index_name:
          type: string
          example: example-index_name
        table_name:
          type: string
          example: example-table_name
      type: object
    HashedTimestampColumnFinderResponse_3:
      example:
        index_command: index_command
        description: description
        current_database: current_database
        index_name: index_name
        table_name: table_name
      properties:
        current_database:
          type: string
          example: example-current_database
        description:
          type: string
          example: Example description
        index_command:
          type: string
          example: example-index_command
        index_name:
          type: string
          example: example-index_name
        table_name:
          type: string
          example: example-table_name
      type: object
    QueryDistributionSuggestionResponse_3:
      example:
        suggestion: suggestion
        description: description
        details:
        - node: node
          numInsert: 6
          numDelete: 0
          numUpdate: 5
          numSelect: 1
        - node: node
          numInsert: 6
          numDelete: 0
          numUpdate: 5
          numSelect: 1
        startTime: startTime
        endTime: endTime
        adviceType: adviceType
      properties:
        adviceType:
          type: string
          example: DEFAULT
        description:
          type: string
          example: Example description
        details:
          items:
            $ref: '#/components/schemas/NodeQueryDistributionDetails_3'
          type: array
          example:
          - node: node
            numInsert: 6
            numDelete: 0
            numUpdate: 5
            numSelect: 1
        endTime:
          type: string
          example: '2026-05-03T12:00:00Z'
        startTime:
          type: string
          example: '2026-05-03T12:00:00Z'
        suggestion:
          type: string
          example: example-suggestion
      required:
      - adviceType
      - description
      - details
      - endTime
      - startTime
      - suggestion
      type: object
    NodeQueryDistributionDetails_3:
      example:
        node: node
        numInsert: 6
        numDelete: 0
        numUpdate: 5
        numSelect: 1
      properties:
        node:
          type: string
          example: node-1
        numDelete:
          format: int32
          type: integer
          example: 10
        numInsert:
          format: int32
          type: integer
          example: 10
        numSelect:
          format: int32
          type: integer
          example: 10
        numUpdate:
          format: int32
          type: integer
          example: 10
      required:
      - node
      - numDelete
      - numInsert
      - numSelect
      - numUpdate
      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-full.yaml
- yugabytedb-anywhere-v1-universes.yaml