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 LoggingConfig API

The LoggingConfig API from YugabyteDB — 2 operation(s) for loggingconfig.

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

Tagged areas include LoggingConfig. 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 2 operations across 2 paths, and defines 4 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.

2 operations 2 paths 4 schemas 2 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 LoggingConfig 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 2

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

LoggingConfig 2
POST
/api/v1/audit_logging_config
YugabyteDB Anywhere Set Audit Logging Level
setAuditLoggingSettings 1 param body → 200
POST
/api/v1/logging_config
YugabyteDB Anywhere Set Logging Level
setLoggingSettings 1 param body → 200

Schemas 4

The contract defines 4 schemas that model the data the API accepts and returns. The most detailed are AuditLoggingConfig_2 (5 properties), AuditLoggingConfig (5 properties), PlatformLoggingConfig_2 (4 properties), PlatformLoggingConfig (4 properties). Each schema is shown below with its type and property counts.

PlatformLoggingConfig
object
4 properties 3 required
AuditLoggingConfig
object
Audit Logging Configuration
5 properties 2 required
PlatformLoggingConfig_2
object
4 properties 3 required
AuditLoggingConfig_2
object
Audit Logging Configuration
5 properties 2 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

yugabytedb-loggingconfig-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