YugabyteDB

YugabyteDB GFlags Validation APIs API

The GFlags Validation APIs API from YugabyteDB — 3 operation(s) for gflags validation apis.

GitHub OpenAPI

Operations 3

GET /api/v1/metadata/version/{version}/gflag Get gflag metadata #
GET /api/v1/metadata/version/{version}/list_gflags List all gflags for a release #
POST /api/v1/metadata/version/{version}/validate_gflags Validate gflags #

Documentation

📖
Documentation
https://docs.yugabyte.com/stable/yugabyte-cloud/managed-automation/managed-api/
📖
APIReference
https://api-docs.yugabyte.com/docs/managed-apis/
📖
GettingStarted
https://docs.yugabyte.com/stable/yugabyte-cloud/managed-automation/managed-api/managed-apikeys/
📖
Authentication
https://docs.yugabyte.com/stable/yugabyte-cloud/managed-automation/managed-api/managed-apikeys/
📖
Documentation
https://docs.yugabyte.com/stable/yugabyte-platform/anywhere-automation/anywhere-api/
📖
APIReference
https://api-docs.yugabyte.com/docs/yugabyte-platform/
📖
GettingStarted
https://docs.yugabyte.com/stable/yugabyte-platform/anywhere-automation/anywhere-api/
📖
Authentication
https://docs.yugabyte.com/stable/yugabyte-platform/anywhere-automation/anywhere-api/

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/yugabytedb/refs/heads/main/openapi/yugabytedb-gflags-validation-apis-api-openapi.yml

Other Resources

🔗
CLI
https://github.com/yugabyte/ybm-cli
🔗
Integrations
https://github.com/yugabyte/terraform-provider-ybm
🔗
TermsOfService
https://www.yugabyte.com/yugabytedb-managed-service-terms/
🔗
SDKs
https://github.com/yugabyte/platform-go-client
🔗
Integrations
https://github.com/yugabyte/terraform-provider-yba
🔗
Integrations
https://github.com/yugabyte/yugabyte-k8s-operator
🔗
KubernetesCRD
https://raw.githubusercontent.com/api-evangelist/yugabytedb/refs/heads/main/crd/yugabytedb-ybuniverse.yaml
🔗
KubernetesCRD
https://raw.githubusercontent.com/api-evangelist/yugabytedb/refs/heads/main/crd/yugabytedb-backup.yaml
🔗
KubernetesCRD
https://raw.githubusercontent.com/api-evangelist/yugabytedb/refs/heads/main/crd/yugabytedb-backup-schedule.yaml
🔗
KubernetesCRD
https://raw.githubusercontent.com/api-evangelist/yugabytedb/refs/heads/main/crd/yugabytedb-restore-job.yaml
🔗
KubernetesCRD
https://raw.githubusercontent.com/api-evangelist/yugabytedb/refs/heads/main/crd/yugabytedb-storage-config.yaml
🔗
KubernetesCRD
https://raw.githubusercontent.com/api-evangelist/yugabytedb/refs/heads/main/crd/yugabytedb-dr-config.yaml
🔗
KubernetesCRD
https://raw.githubusercontent.com/api-evangelist/yugabytedb/refs/heads/main/crd/yugabytedb-pitr-config.yaml
🔗
KubernetesCRD
https://raw.githubusercontent.com/api-evangelist/yugabytedb/refs/heads/main/crd/yugabytedb-release.yaml
🔗
KubernetesCRD
https://raw.githubusercontent.com/api-evangelist/yugabytedb/refs/heads/main/crd/yugabytedb-support-bundle.yaml
🔗
KubernetesCRD
https://raw.githubusercontent.com/api-evangelist/yugabytedb/refs/heads/main/crd/yugabytedb-ybcertificate.yaml
🔗
KubernetesCRD
https://raw.githubusercontent.com/api-evangelist/yugabytedb/refs/heads/main/crd/yugabytedb-ybprovider.yaml
🔗
KubernetesCRD
https://raw.githubusercontent.com/api-evangelist/yugabytedb/refs/heads/main/crd/yugabytedb-ybplatform.yaml

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-gflags-validation-apis-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

yugabytedb-gflags-validation-apis-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Yugabytedb GFlags Validation APIs 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 GFlags Validation APIs 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: GFlags Validation APIs
paths:
  /api/v1/metadata/version/{version}/gflag:
    get:
      description: 'WARNING: This is a preview API that could change.'
      operationId: getGFlagMetadata
      parameters:
      - in: path
        name: version
        required: true
        schema:
          type: string
      - in: query
        name: name
        schema:
          type: string
      - in: query
        name: server
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GFlagDetails'
          description: successful operation
      security:
      - apiKeyAuth: []
      summary: Get gflag metadata
      tags:
      - GFlags Validation APIs
    servers:
    - url: /
  /api/v1/metadata/version/{version}/list_gflags:
    get:
      description: 'WARNING: This is a preview API that could change.'
      operationId: listGFlags
      parameters:
      - in: path
        name: version
        required: true
        schema:
          type: string
      - in: query
        name: name
        schema:
          type: string
      - in: query
        name: server
        schema:
          type: string
      - in: query
        name: mostUsedGFlags
        schema:
          default: false
          type: boolean
      - in: query
        name: showExperimental
        schema:
          default: false
          type: boolean
      responses:
        '200':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/GFlagDetails'
                type: array
          description: successful operation
      security:
      - apiKeyAuth: []
      summary: List all gflags for a release
      tags:
      - GFlags Validation APIs
    servers:
    - url: /
  /api/v1/metadata/version/{version}/validate_gflags:
    post:
      description: 'WARNING: This is a preview API that could change.'
      operationId: validateGFlags
      parameters:
      - in: path
        name: version
        required: true
        schema:
          type: string
      - in: query
        name: request
        schema: {}
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/GFlagsValidationFormData'
        description: GFlag validation form data
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/GFlagsValidationResponse'
                type: array
          description: successful operation
      security:
      - apiKeyAuth: []
      summary: Validate gflags
      tags:
      - GFlags Validation APIs
      x-codegen-request-body-name: gflag_validation_form_data
    servers:
    - url: /
components:
  schemas:
    GFlagDetails:
      example:
        current: current
        default: default
        file: file
        initial: initial
        meaning: meaning
        name: name
        type: type
        tags: tags
        target: target
      properties:
        current:
          description: 'WARNING: This is a preview API that could change. Current value of the gflag'
          type: string
        default:
          description: 'WARNING: This is a preview API that could change. Default value of the gflag'
          type: string
        file:
          description: 'WARNING: This is a preview API that could change. File where the gflag is defined'
          type: string
        initial:
          description: 'WARNING: This is a preview API that could change. Initial value of the gflag'
          type: string
        meaning:
          description: 'WARNING: This is a preview API that could change. Meaning of the gflag'
          type: string
        name:
          description: 'WARNING: This is a preview API that could change. Name of the gflag'
          type: string
        tags:
          description: 'WARNING: This is a preview API that could change. Tags of the gflag'
          type: string
        target:
          description: 'WARNING: This is a preview API that could change. Target of the gflag'
          type: string
        type:
          description: 'WARNING: This is a preview API that could change. Type of the gflag'
          type: string
      type: object
    GFlagsValidationResponse:
      example:
        MASTER:
          exist: true
          error: error
        TSERVER:
          exist: true
          error: error
        Name: Name
      properties:
        MASTER:
          $ref: '#/components/schemas/GFlagValidationDetails'
        Name:
          description: 'WARNING: This is a preview API that could change. Name of the gflag'
          type: string
        TSERVER:
          $ref: '#/components/schemas/GFlagValidationDetails'
      type: object
    GFlagValidationDetails:
      example:
        exist: true
        error: error
      properties:
        error:
          description: 'WARNING: This is a preview API that could change. Error message if gflag is invalid'
          type: string
        exist:
          description: 'WARNING: This is a preview API that could change. Flag to indicate if gflag exists'
          type: boolean
      type: object
    GFlagsValidationFormData:
      example:
        gflags:
        - MASTER: MASTER
          TSERVER: TSERVER
          Name: Name
        - MASTER: MASTER
          TSERVER: TSERVER
          Name: Name
      properties:
        gflags:
          description: 'WARNING: This is a preview API that could change. List of gflags to validate'
          items:
            $ref: '#/components/schemas/GFlagsValidationRequest'
          type: array
      type: object
    GFlagsValidationRequest:
      example:
        MASTER: MASTER
        TSERVER: TSERVER
        Name: Name
      properties:
        MASTER:
          description: 'WARNING: This is a preview API that could change. Value of the gflag for master'
          type: string
        Name:
          description: 'WARNING: This is a preview API that could change. Name of the gflag'
          type: string
        TSERVER:
          description: 'WARNING: This is a preview API that could change. Value of the gflag for tserver'
          type: string
      type: object
    GFlagDetails_2:
      example:
        current: current
        default: default
        file: file
        initial: initial
        meaning: meaning
        name: name
        type: type
        tags: tags
        target: target
      properties:
        current:
          description: 'WARNING: This is a preview API that could change. Current value of the gflag'
          type: string
          example: example-current
        default:
          description: 'WARNING: This is a preview API that could change. Default value of the gflag'
          type: string
          example: example-default
        file:
          description: 'WARNING: This is a preview API that could change. File where the gflag is defined'
          type: string
          example: example-file
        initial:
          description: 'WARNING: This is a preview API that could change. Initial value of the gflag'
          type: string
          example: example-initial
        meaning:
          description: 'WARNING: This is a preview API that could change. Meaning of the gflag'
          type: string
          example: example-meaning
        name:
          description: 'WARNING: This is a preview API that could change. Name of the gflag'
          type: string
          example: example-name
        tags:
          description: 'WARNING: This is a preview API that could change. Tags of the gflag'
          type: string
          example: example-tag
        target:
          description: 'WARNING: This is a preview API that could change. Target of the gflag'
          type: string
          example: example-target
        type:
          description: 'WARNING: This is a preview API that could change. Type of the gflag'
          type: string
          example: DEFAULT
      type: object
    GFlagsValidationResponse_2:
      example:
        MASTER:
          exist: true
          error: error
        TSERVER:
          exist: true
          error: error
        Name: Name
      properties:
        MASTER:
          $ref: '#/components/schemas/GFlagValidationDetails_2'
        Name:
          description: 'WARNING: This is a preview API that could change. Name of the gflag'
          type: string
          example: example-Name
        TSERVER:
          $ref: '#/components/schemas/GFlagValidationDetails_2'
      type: object
    GFlagValidationDetails_2:
      example:
        exist: true
        error: error
      properties:
        error:
          description: 'WARNING: This is a preview API that could change. Error message if gflag is invalid'
          type: string
          example: example-error
        exist:
          description: 'WARNING: This is a preview API that could change. Flag to indicate if gflag exists'
          type: boolean
          example: true
      type: object
    GFlagsValidationFormData_2:
      example:
        gflags:
        - MASTER: MASTER
          TSERVER: TSERVER
          Name: Name
        - MASTER: MASTER
          TSERVER: TSERVER
          Name: Name
      properties:
        gflags:
          description: 'WARNING: This is a preview API that could change. List of gflags to validate'
          items:
            $ref: '#/components/schemas/GFlagsValidationRequest_2'
          type: array
          example:
          - MASTER: MASTER
            TSERVER: TSERVER
            Name: Name
      type: object
    GFlagsValidationRequest_2:
      example:
        MASTER: MASTER
        TSERVER: TSERVER
        Name: Name
      properties:
        MASTER:
          description: 'WARNING: This is a preview API that could change. Value of the gflag for master'
          type: string
          example: example-MASTER
        Name:
          description: 'WARNING: This is a preview API that could change. Name of the gflag'
          type: string
          example: example-Name
        TSERVER:
          description: 'WARNING: This is a preview API that could change. Value of the gflag for tserver'
          type: string
          example: example-TSERVER
      type: object
    GFlagDetails_3:
      example:
        current: current
        default: default
        file: file
        initial: initial
        meaning: meaning
        name: name
        type: type
        tags: tags
        target: target
      properties:
        current:
          description: 'WARNING: This is a preview API that could change. Current value of the gflag'
          type: string
          example: example-current
        default:
          description: 'WARNING: This is a preview API that could change. Default value of the gflag'
          type: string
          example: example-default
        file:
          description: 'WARNING: This is a preview API that could change. File where the gflag is defined'
          type: string
          example: example-file
        initial:
          description: 'WARNING: This is a preview API that could change. Initial value of the gflag'
          type: string
          example: example-initial
        meaning:
          description: 'WARNING: This is a preview API that could change. Meaning of the gflag'
          type: string
          example: example-meaning
        name:
          description: 'WARNING: This is a preview API that could change. Name of the gflag'
          type: string
          example: example-name
        tags:
          description: 'WARNING: This is a preview API that could change. Tags of the gflag'
          type: string
          example: example-tag
        target:
          description: 'WARNING: This is a preview API that could change. Target of the gflag'
          type: string
          example: example-target
        type:
          description: 'WARNING: This is a preview API that could change. Type of the gflag'
          type: string
          example: DEFAULT
      type: object
    GFlagsValidationResponse_3:
      example:
        MASTER:
          exist: true
          error: error
        TSERVER:
          exist: true
          error: error
        Name: Name
      properties:
        MASTER:
          $ref: '#/components/schemas/GFlagValidationDetails_3'
        Name:
          description: 'WARNING: This is a preview API that could change. Name of the gflag'
          type: string
          example: example-Name
        TSERVER:
          $ref: '#/components/schemas/GFlagValidationDetails_3'
      type: object
    GFlagValidationDetails_3:
      example:
        exist: true
        error: error
      properties:
        error:
          description: 'WARNING: This is a preview API that could change. Error message if gflag is invalid'
          type: string
          example: example-error
        exist:
          description: 'WARNING: This is a preview API that could change. Flag to indicate if gflag exists'
          type: boolean
          example: true
      type: object
    GFlagsValidationFormData_3:
      example:
        gflags:
        - MASTER: MASTER
          TSERVER: TSERVER
          Name: Name
        - MASTER: MASTER
          TSERVER: TSERVER
          Name: Name
      properties:
        gflags:
          description: 'WARNING: This is a preview API that could change. List of gflags to validate'
          items:
            $ref: '#/components/schemas/GFlagsValidationRequest_3'
          type: array
          example:
          - MASTER: MASTER
            TSERVER: TSERVER
            Name: Name
      type: object
    GFlagsValidationRequest_3:
      example:
        MASTER: MASTER
        TSERVER: TSERVER
        Name: Name
      properties:
        MASTER:
          description: 'WARNING: This is a preview API that could change. Value of the gflag for master'
          type: string
          example: example-MASTER
        Name:
          description: 'WARNING: This is a preview API that could change. Name of the gflag'
          type: string
          example: example-Name
        TSERVER:
          description: 'WARNING: This is a preview API that could change. Value of the gflag for tserver'
          type: string
          example: example-TSERVER
      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