YugabyteDB

YugabyteDB Metrics API

The Metrics API from YugabyteDB — 2 operation(s) for metrics.

Documentation GitHub OpenAPI

Operations 2

GET /host-info Get Prometheus host info #

GET /api/v1/prometheus_metrics Get Prometheus metrics #

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-metrics-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 Metrics API
  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
  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
  version: '1.0'
  description: 'Operations tagged Metrics across 6 of this provider''s published API definitions: openapi.yaml, openapi_2.yaml, platform.swagger.json, yugabytedb-anywhere-v1-alerts-monitoring.yaml, yugabytedb-anywhere-v1-full.yaml, yugabytedb-anywhere-v2-openapi.yaml. Each path carries the servers of the definition it was published in.'
servers:
- description: API endpoint of YBA server
  url: '{protocol}://{host_port}/api/v2'
  variables:
    protocol:
      default: http
      enum:
      - http
      - https
    host_port:
      default: localhost:9000
- url: /
tags:
- description: CRUD operations for YBA metrics
  name: Metrics
paths:
  /host-info:
    get:
      description: Get the Url for the Prometheus instance of the current YBA
      operationId: GetPrometheusHostInfo
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PrometheusHostInfo'
          description: success
          x-yba-api-visibility: internal
        '400':
          description: Client Error
        '500':
          description: Server Error
      security:
      - apiKeyAuth: []
      summary: Get Prometheus host info
      tags:
      - Metrics
      x-yba-api-audit:
        noAudit: true
      x-yba-api-authz:
        noAuthz: true
      x-yba-api-since: 2024.2.0.0
      x-yba-api-visibility: internal
      x-accepts:
      - application/json
    servers:
    - description: API endpoint of YBA server
      url: '{protocol}://{host_port}/api/v2'
      variables:
        protocol:
          default: http
          enum:
          - http
          - https
        host_port:
          default: localhost:9000
  /api/v1/prometheus_metrics:
    get:
      description: Available since YBA version 2.8.0.0.
      operationId: MetricsDetail
      parameters:
      - in: query
        name: request
        schema: {}
      responses:
        '200':
          content:
            application/json:
              schema:
                type: string
          description: successful operation
      security:
      - apiKeyAuth: []
      summary: Get Prometheus metrics
      tags:
      - Metrics
    servers:
    - url: /
components:
  schemas:
    PrometheusHostInfo:
      description: 'PrometheusHostInfo


        Information about the the Prometheus instance for the current YBA. Part of PrometheusHostInfoResp.

        '
      example:
        prometheus_url: https://localhost:9000
        use_browser_fqdn: true
      properties:
        prometheus_url:
          description: URL for accessing Prometheus
          example: https://localhost:9000
          readOnly: true
          type: string
        use_browser_fqdn:
          description: If the Prometheus link in the browser should use the browser's FQDN or use prometheus url directly.
          readOnly: true
          type: boolean
      required:
      - prometheus_url
      - use_browser_fqdn
      title: PrometheusHostInfo
      type: object
      x-yba-api-visibility: internal
    PrometheusHostInfo_2:
      description: 'PrometheusHostInfo


        Information about the the Prometheus instance for the current YBA. Part of PrometheusHostInfoResp.

        '
      example:
        prometheus_url: https://localhost:9000
        use_browser_fqdn: true
      properties:
        prometheus_url:
          description: URL for accessing Prometheus
          example: https://localhost:9000
          readOnly: true
          type: string
        use_browser_fqdn:
          description: If the Prometheus link in the browser should use the browser's FQDN or use prometheus url directly.
          readOnly: true
          type: boolean
          example: true
      required:
      - prometheus_url
      - use_browser_fqdn
      title: PrometheusHostInfo
      type: object
      x-yba-api-visibility: internal
  securitySchemes:
    apiKeyAuth:
      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.yaml
- openapi_2.yaml
- platform.swagger.json
- yugabytedb-anywhere-v1-alerts-monitoring.yaml
- yugabytedb-anywhere-v1-full.yaml
- yugabytedb-anywhere-v2-openapi.yaml