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 GFlags Validation APIs API

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

YugabyteDB GFlags Validation APIs API is one of 73 APIs that YugabyteDB publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include GFlags Validation APIs. 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 3 operations across 3 paths, and defines 10 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.

3 operations 3 paths 10 schemas 2 GET1 POST

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 GFlags Validation APIs 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 3

Across 3 paths, the API surfaces 3 operations — 2 GET, 1 POST. Each is listed below with its method, path, parameters, and response codes.

GFlags Validation APIs 3
GET
/api/v1/metadata/version/{version}/gflag
YugabyteDB Anywhere Get Gflag Metadata
getGFlagMetadata 3 params → 200
GET
/api/v1/metadata/version/{version}/list_gflags
YugabyteDB Anywhere List All Gflags for a Release
listGFlags 5 params → 200
POST
/api/v1/metadata/version/{version}/validate_gflags
YugabyteDB Anywhere Validate Gflags
validateGFlags 2 params body → 200

Schemas 10

The contract defines 10 schemas that model the data the API accepts and returns. The most detailed are GFlagDetails (9 properties), GFlagDetails_2 (9 properties), GFlagsValidationResponse_2 (3 properties), GFlagsValidationRequest (3 properties). Each schema is shown below with its type and property counts.

GFlagsValidationRequest
object
3 properties
GFlagsValidationResponse
object
3 properties
GFlagsValidationFormData
object
1 property
GFlagDetails
object
9 properties
GFlagValidationDetails
object
2 properties
GFlagsValidationRequest_2
object
3 properties
GFlagsValidationResponse_2
object
3 properties
GFlagsValidationFormData_2
object
1 property
GFlagDetails_2
object
9 properties
GFlagValidationDetails_2
object
2 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

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