YugabyteDB

YugabyteDB LoggingConfig API

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

Documentation GitHub OpenAPI

Operations 2

POST /api/v1/audit_logging_config Set Audit Logging Level #

POST /api/v1/logging_config Set Logging Level #

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-loggingconfig-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 Logging Config 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 LoggingConfig across 4 of this provider''s published API definitions: openapi_2.yaml, platform.swagger.json, yugabytedb-anywhere-v1-alerts-monitoring.yaml, yugabytedb-anywhere-v1-full.yaml. Each path carries the servers of the definition it was published in.'
servers:
- url: /
tags:
- name: LoggingConfig
paths:
  /api/v1/audit_logging_config:
    post:
      operationId: setAuditLoggingSettings
      parameters:
      - in: query
        name: request
        schema: {}
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AuditLoggingConfig'
        description: Audit Logging config to be updated
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AuditLoggingConfig'
          description: successful operation
      security:
      - apiKeyAuth: []
      summary: Set Audit Logging Level
      tags:
      - LoggingConfig
      x-codegen-request-body-name: Audit Logging Config
    servers:
    - url: /
  /api/v1/logging_config:
    post:
      operationId: setLoggingSettings
      parameters:
      - in: query
        name: request
        schema: {}
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PlatformLoggingConfig'
        description: Logging config to be updated
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PlatformLoggingConfig'
          description: successful operation
      security:
      - apiKeyAuth: []
      summary: Set Logging Level
      tags:
      - LoggingConfig
      x-codegen-request-body-name: Logging Config
    servers:
    - url: /
components:
  schemas:
    PlatformLoggingConfig:
      example:
        level: ERROR
        maxHistory: 0
        fileNamePrefix: yb-platform-
        rolloverPattern: rolloverPattern
      properties:
        fileNamePrefix:
          description: 'WARNING: This is a preview API that could change. Application log file name prefix. Defaults to "". For example, setting this to "yb-platform-" will generate application log files as "yb-platform-application.log" instead of "application.log".'
          example: yb-platform-
          type: string
        level:
          enum:
          - ERROR
          - WARN
          - INFO
          - DEBUG
          - TRACE
          type: string
        maxHistory:
          format: int32
          minimum: 0
          type: integer
        rolloverPattern:
          type: string
      required:
      - level
      - maxHistory
      - rolloverPattern
      type: object
    AuditLoggingConfig:
      description: Audit Logging Configuration
      example:
        outputToStdout: true
        maxHistory: 30
        fileNamePrefix: yb-platform-
        rolloverPattern: yyyy-MM-dd
        outputToFile: true
      properties:
        fileNamePrefix:
          description: 'WARNING: This is a preview API that could change. Audit log file name prefix. Defaults to "". For example, setting this to "yb-platform-" will generate audit log files as "yb-platform-audit.log" instead of "audit.log".'
          example: yb-platform-
          type: string
        maxHistory:
          description: Max number of days up till which logs are kept
          example: 30
          format: int32
          minimum: 0
          type: integer
        outputToFile:
          description: Flag to enable/disable audit logs output to file
          type: boolean
        outputToStdout:
          description: Flag to enable/disable audit logs output to stdout
          type: boolean
        rolloverPattern:
          description: Rollover Pattern
          example: yyyy-MM-dd
          type: string
      required:
      - outputToFile
      - outputToStdout
      type: object
    PlatformLoggingConfig_2:
      properties:
        level:
          enum:
          - ERROR
          - WARN
          - INFO
          - DEBUG
          - TRACE
          type: string
        maxHistory:
          format: int32
          minimum: 0
          type: integer
        rolloverPattern:
          type: string
      required:
      - level
      - maxHistory
      - rolloverPattern
      type: object
    AuditLoggingConfig_2:
      description: Audit Logging Configuration
      properties:
        maxHistory:
          description: Max number of days up till which logs are kept
          example: 30
          format: int32
          minimum: 0
          type: integer
        outputToFile:
          description: Flag to enable/disable audit logs output to file
          type: boolean
        outputToStdout:
          description: Flag to enable/disable audit logs output to stdout
          type: boolean
        rolloverPattern:
          description: Rollover Pattern
          example: yyyy-MM-dd
          type: string
      required:
      - outputToFile
      - outputToStdout
      type: object
    PlatformLoggingConfig_3:
      example:
        level: ERROR
        maxHistory: 0
        fileNamePrefix: yb-platform-
        rolloverPattern: rolloverPattern
      properties:
        fileNamePrefix:
          description: 'WARNING: This is a preview API that could change. Application log file name prefix. Defaults to "". For example, setting this to "yb-platform-" will generate application log files as "yb-platform-application.log" instead of "application.log".'
          example: yb-platform-
          type: string
        level:
          enum:
          - ERROR
          - WARN
          - INFO
          - DEBUG
          - TRACE
          type: string
          example: ERROR
        maxHistory:
          format: int32
          minimum: 0
          type: integer
          example: 10
        rolloverPattern:
          type: string
          example: example-rolloverPattern
      required:
      - level
      - maxHistory
      - rolloverPattern
      type: object
    AuditLoggingConfig_3:
      description: Audit Logging Configuration
      example:
        outputToStdout: true
        maxHistory: 30
        fileNamePrefix: yb-platform-
        rolloverPattern: yyyy-MM-dd
        outputToFile: true
      properties:
        fileNamePrefix:
          description: 'WARNING: This is a preview API that could change. Audit log file name prefix. Defaults to "". For example, setting this to "yb-platform-" will generate audit log files as "yb-platform-audit.log" instead of "audit.log".'
          example: yb-platform-
          type: string
        maxHistory:
          description: Max number of days up till which logs are kept
          example: 30
          format: int32
          minimum: 0
          type: integer
        outputToFile:
          description: Flag to enable/disable audit logs output to file
          type: boolean
          example: true
        outputToStdout:
          description: Flag to enable/disable audit logs output to stdout
          type: boolean
          example: true
        rolloverPattern:
          description: Rollover Pattern
          example: yyyy-MM-dd
          type: string
      required:
      - outputToFile
      - outputToStdout
      type: object
    PlatformLoggingConfig_4:
      example:
        level: ERROR
        maxHistory: 0
        fileNamePrefix: yb-platform-
        rolloverPattern: rolloverPattern
      properties:
        fileNamePrefix:
          description: 'WARNING: This is a preview API that could change. Application log file name prefix. Defaults to "". For example, setting this to "yb-platform-" will generate application log files as "yb-platform-application.log" instead of "application.log".'
          example: yb-platform-
          type: string
        level:
          enum:
          - ERROR
          - WARN
          - INFO
          - DEBUG
          - TRACE
          type: string
          example: ERROR
        maxHistory:
          format: int32
          minimum: 0
          type: integer
          example: 10
        rolloverPattern:
          type: string
          example: example-rolloverPattern
      required:
      - level
      - maxHistory
      - rolloverPattern
      type: object
    AuditLoggingConfig_4:
      description: Audit Logging Configuration
      example:
        outputToStdout: true
        maxHistory: 30
        fileNamePrefix: yb-platform-
        rolloverPattern: yyyy-MM-dd
        outputToFile: true
      properties:
        fileNamePrefix:
          description: 'WARNING: This is a preview API that could change. Audit log file name prefix. Defaults to "". For example, setting this to "yb-platform-" will generate audit log files as "yb-platform-audit.log" instead of "audit.log".'
          example: yb-platform-
          type: string
        maxHistory:
          description: Max number of days up till which logs are kept
          example: 30
          format: int32
          minimum: 0
          type: integer
        outputToFile:
          description: Flag to enable/disable audit logs output to file
          type: boolean
          example: true
        outputToStdout:
          description: Flag to enable/disable audit logs output to stdout
          type: boolean
          example: true
        rolloverPattern:
          description: Rollover Pattern
          example: yyyy-MM-dd
          type: string
      required:
      - outputToFile
      - outputToStdout
      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
- platform.swagger.json
- yugabytedb-anywhere-v1-alerts-monitoring.yaml
- yugabytedb-anywhere-v1-full.yaml