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

The Audit API from YugabyteDB — 3 operation(s) for audit.

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

Tagged areas include Audit. 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 2 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 2 schemas 3 GET

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 Audit 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 — 3 GET. Each is listed below with its method, path, parameters, and response codes.

Audit 3
GET
/api/v1/customers/{cUUID}/tasks/{tUUID}/audit_info
YugabyteDB Anywhere Get Audit Info for a Task
getTaskAudit 2 params → 200
GET
/api/v1/customers/{cUUID}/tasks/{tUUID}/audit_user
YugabyteDB Anywhere Get the User Associated with a Task
getUserFromTask 2 params → 200
GET
/api/v1/customers/{cUUID}/users/{uUUID}/audit_trail
YugabyteDB Anywhere List a User's Audit Entries
ListOfAudit 2 params → 200

Schemas 2

The contract defines 2 schemas that model the data the API accepts and returns. The most detailed are Audit_2 (14 properties), Audit (14 properties). Each schema is shown below with its type and property counts.

Audit
object
Audit logging for requests and responses
14 properties
Audit_2
object
Audit logging for requests and responses
14 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

yugabytedb-audit-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 Authentication API
YugabyteDB Availability Zones API
YugabyteDB Backup and Restore API
YugabyteDB Backups API
YugabyteDB Certificate Info API
YugabyteDB Cloud providers API
YugabyteDB Clusters API