YugabyteDB

YugabyteDB Audit API

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

GitHub OpenAPI

Operations 3

GET /api/v1/customers/{cUUID}/tasks/{tUUID}/audit_info Get audit info for a task #
GET /api/v1/customers/{cUUID}/tasks/{tUUID}/audit_user Get the user associated with a task #
GET /api/v1/customers/{cUUID}/users/{uUUID}/audit_trail List a user's audit entries #

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-audit-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-audit-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-audit-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Yugabytedb Audit 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 Audit 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: Audit
paths:
  /api/v1/customers/{cUUID}/tasks/{tUUID}/audit_info:
    get:
      operationId: getTaskAudit
      parameters:
      - in: path
        name: cUUID
        required: true
        schema:
          format: uuid
          type: string
      - in: path
        name: tUUID
        required: true
        schema:
          format: uuid
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Audit'
          description: successful operation
      security:
      - apiKeyAuth: []
      summary: Get audit info for a task
      tags:
      - Audit
    servers:
    - url: /
  /api/v1/customers/{cUUID}/tasks/{tUUID}/audit_user:
    get:
      operationId: getUserFromTask
      parameters:
      - in: path
        name: cUUID
        required: true
        schema:
          format: uuid
          type: string
      - in: path
        name: tUUID
        required: true
        schema:
          format: uuid
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Audit'
          description: successful operation
      security:
      - apiKeyAuth: []
      summary: Get the user associated with a task
      tags:
      - Audit
    servers:
    - url: /
  /api/v1/customers/{cUUID}/users/{uUUID}/audit_trail:
    get:
      operationId: ListOfAudit
      parameters:
      - in: path
        name: cUUID
        required: true
        schema:
          format: uuid
          type: string
      - in: path
        name: uUUID
        required: true
        schema:
          format: uuid
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/Audit'
                type: array
          description: successful operation
      security:
      - apiKeyAuth: []
      summary: List a user's audit entries
      tags:
      - Audit
    servers:
    - url: /
components:
  schemas:
    Audit:
      description: Audit logging for requests and responses
      example:
        auditID: 0
        targetID: targetID
        additionalDetails: '{}'
        taskUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
        target: User
        userAddress: userAddress
        apiMethod: GET
        customerUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
        payload: '{}'
        action: Create User
        apiCall: /api/v1/customers/<496fdea8-df25-11eb-ba80-0242ac130004>/providers
        userEmail: userEmail
        userUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
        timestamp: 2022-12-12 13:07:18+00:00
      properties:
        action:
          description: Action
          enum:
          - Set
          - Create
          - Edit
          - Update
          - Delete
          - Register
          - Refresh
          - Upload
          - Upgrade
          - Import
          - Attach
          - Pause
          - Resume
          - Restart
          - Abort
          - Retry
          - Rollback
          - Restore
          - Alter
          - Drop
          - Stop
          - Validate
          - Acknowledge
          - SyncXClusterConfig
          - SyncDrConfig
          - Failover
          - Switchover
          - Login
          - ApiLogin
          - Promote
          - Bootstrap
          - Configure
          - UpdateOptions
          - UpdateLoadBalancerConfig
          - RefreshPricing
          - UpgradeSoftware
          - FinalizeUpgrade
          - RollbackUpgrade
          - UpgradeGFlags
          - CreateTelemetryConfig
          - DeleteTelemetryConfig
          - CreatePACollectorConfig
          - EditPACollectorConfig
          - DeletePACollectorConfig
          - PACollectorRegister
          - PACollectorUnregister
          - UpgradeKubernetesOverrides
          - UpgradeCerts
          - UpgradeTLS
          - UpgradeVmImage
          - UpgradeSystemd
          - RebootUniverse
          - ResizeNode
          - AddMetrics
          - CreateKubernetes
          - SetupDocker
          - RetrieveKmsKey
          - RemoveKmsKeyReferenceHistory
          - UpsertCustomerFeatures
          - CreateSelfSignedCert
          - UpdateEmptyCustomerCertificate
          - GetRootCertificate
          - AddClientCertificate
          - SetDBCredentials
          - CreateUserInDB
          - CreateRestrictedUserInDB
          - DropUserInDB
          - SetHelm3Compatible
          - SetBackupFlag
          - SetUniverseKey
          - ResetUniverseVersion
          - ConfigUniverseAlert
          - ToggleTls
          - ModifyAuditLogging
          - ModifyQueryLogging
          - ConfigureMetricsExport
          - TlsConfigUpdate
          - UpdateDiskSize
          - CreateCluster
          - DeleteCluster
          - CreateAllClusters
          - UpdatePrimaryCluster
          - UpdateReadOnlyCluster
          - CreateReadOnlyCluster
          - DeleteReadOnlyCluster
          - RunYsqlQuery
          - BulkImport
          - CreateBackup
          - RestoreBackup
          - CreateSingleTableBackup
          - CreateMultiTableBackup
          - CreateBackupSchedule
          - CreatePitrConfig
          - UpdatePitrConfig
          - RestoreSnapshotSchedule
          - DeletePitrConfig
          - EditBackupSchedule
          - StartPeriodicBackup
          - StopPeriodicBackup
          - DetachedNodeInstanceAction
          - NodeInstanceAction
          - DeleteBackupSchedule
          - ChangeUserRole
          - ChangeUserPassword
          - SetSecurity
          - GenerateApiToken
          - ResetSlowQueries
          - ExternalScriptSchedule
          - StopScheduledScript
          - UpdateScheduledScript
          - CreateInstanceType
          - DeleteInstanceType
          - GetUniverseResources
          - ThirdpartySoftwareUpgrade
          - CreateTableSpaces
          - CreateHook
          - DeleteHook
          - UpdateHook
          - CreateHookScope
          - DeleteHookScope
          - AddHook
          - RemoveHook
          - RotateAccessKey
          - CreateAndRotateAccessKey
          - RunHook
          - RunApiTriggeredHooks
          - AddNodeAgent
          - UpdateNodeAgent
          - DeleteNodeAgent
          - DisableYbc
          - UpgradeYbc
          - InstallYbc
          - UpgradeYbcGFlags
          - SetThrottleParams
          - CreateImageBundle
          - DeleteImageBundle
          - EditImageBundle
          - Detach
          - RollbackDetach
          - DeleteAttachDetachMetadata
          - Unlock
          - LdapUniverseSync
          - UpdateProxyConfig
          - ProvisionUniverseNodes
          - CloneNamespace
          - UpdateAdditionalServicesState
          - KubernetesToggleImmutableYbc
          - OperatorImportUniverse
          - RunScript
          - CreateFileCollection
          - DownloadFileCollection
          - DeleteFileCollection
          example: Create User
          readOnly: true
          type: string
        additionalDetails:
          description: Additional Details
          properties: {}
          readOnly: true
          type: object
        apiCall:
          description: API call
          example: /api/v1/customers/<496fdea8-df25-11eb-ba80-0242ac130004>/providers
          readOnly: true
          type: string
        apiMethod:
          description: API method
          example: GET
          readOnly: true
          type: string
        auditID:
          description: Audit UID
          format: int64
          readOnly: true
          type: integer
        customerUUID:
          description: Customer UUID
          format: uuid
          readOnly: true
          type: string
        payload:
          description: Audit UUID
          properties: {}
          readOnly: true
          type: object
        target:
          description: Target
          enum:
          - Session
          - CloudProvider
          - Region
          - AvailabilityZone
          - CustomerConfig
          - KMSConfig
          - Customer
          - Release
          - Certificate
          - CustomCACertificate
          - Alert
          - AlertTemplateSettings
          - AlertTemplateVariables
          - AlertChannel
          - AlertChannelTemplates
          - AlertDestination
          - MaintenanceWindow
          - AccessKey
          - Universe
          - XClusterConfig
          - DrConfig
          - Table
          - Backup
          - CustomerTask
          - NodeInstance
          - PlatformInstance
          - Schedule
          - User
          - LoggingConfig
          - RuntimeConfigKey
          - HAConfig
          - HABackup
          - ScheduledScript
          - SupportBundle
          - TelemetryProvider
          - PACollector
          - GFlags
          - Hook
          - HookScope
          - NodeAgent
          - CustomerLicense
          - PerformanceRecommendation
          - PerformanceAdvisorSettings
          - PerformanceAdvisorRun
          - Role
          - RoleBinding
          - GroupMapping
          - JobSchedule
          - ContinuousBackup
          - IsolatedBackup
          example: User
          readOnly: true
          type: string
        targetID:
          description: Target ID
          readOnly: true
          type: string
        taskUUID:
          description: Task UUID
          format: uuid
          readOnly: true
          type: string
        timestamp:
          description: The task creation time.
          example: 2022-12-12 13:07:18+00:00
          format: date-time
          readOnly: true
          type: string
        userAddress:
          description: User IP Address
          readOnly: true
          type: string
        userEmail:
          description: User Email
          readOnly: true
          type: string
        userUUID:
          description: User UUID
          format: uuid
          readOnly: true
          type: string
      type: object
    Audit_2:
      description: Audit logging for requests and responses
      properties:
        action:
          description: Action
          enum:
          - Set
          - Create
          - Edit
          - Update
          - Delete
          - Register
          - Refresh
          - Upload
          - Upgrade
          - Import
          - Pause
          - Resume
          - Restart
          - Abort
          - Retry
          - Restore
          - Alter
          - Drop
          - Stop
          - Validate
          - Acknowledge
          - SyncXClusterConfig
          - Login
          - Promote
          - Bootstrap
          - Configure
          - RefreshPricing
          - UpgradeSoftware
          - UpgradeGFlags
          - UpgradeCerts
          - UpgradeTLS
          - UpgradeVmImage
          - UpgradeSystemd
          - ResizeNode
          - AddMetrics
          - CreateKubernetes
          - SetupDocker
          - RetrieveKmsKey
          - RemoveKmsKeyReferenceHistory
          - UpsertCustomerFeatures
          - CreateSelfSignedCert
          - UpdateEmptyCustomerCertificate
          - GetRootCertificate
          - AddClientCertificate
          - SetDBCredentials
          - CreateUserInDB
          - SetHelm3Compatible
          - SetBackupFlag
          - SetUniverseKey
          - ResetUniverseVersion
          - ConfigUniverseAlert
          - ToggleTls
          - TlsConfigUpdate
          - UpdateDiskSize
          - CreateCluster
          - DeleteCluster
          - CreateAllClusters
          - UpdatePrimaryCluster
          - UpdateReadOnlyCluster
          - CreateReadOnlyCluster
          - DeleteReadOnlyCluster
          - RunYsqlQuery
          - BulkImport
          - CreateBackup
          - RestoreBackup
          - CreateSingleTableBackup
          - CreateMultiTableBackup
          - CreateBackupSchedule
          - EditBackupSchedule
          - StartPeriodicBackup
          - StopPeriodicBackup
          - DetachedNodeInstanceAction
          - NodeInstanceAction
          - DeleteBackupSchedule
          - ChangeUserRole
          - ChangeUserPassword
          - SetSecurity
          - GenerateApiToken
          - ResetSlowQueries
          - ExternalScriptSchedule
          - StopScheduledScript
          - UpdateScheduledScript
          - CreateInstanceType
          - DeleteInstanceType
          - GetUniverseResources
          - ThirdpartySoftwareUpgrade
          - CreateTableSpaces
          example: Create User
          readOnly: true
          type: string
        additionalDetails:
          description: Additional Details
          readOnly: true
          type: object
        apiCall:
          description: API call
          example: /api/v1/customers/<496fdea8-df25-11eb-ba80-0242ac130004>/providers
          readOnly: true
          type: string
        apiMethod:
          description: API method
          example: GET
          readOnly: true
          type: string
        auditID:
          format: int64
          type: integer
        customerUUID:
          description: Customer UUID
          format: uuid
          readOnly: true
          type: string
        payload:
          description: Audit UUID
          readOnly: true
          type: object
        target:
          description: Target
          enum:
          - Session
          - CloudProvider
          - Region
          - AvailabilityZone
          - CustomerConfig
          - KMSConfig
          - Customer
          - Release
          - Certificate
          - Alert
          - AlertChannel
          - AlertDestination
          - MaintenanceWindow
          - AccessKey
          - Universe
          - XClusterConfig
          - Table
          - Backup
          - CustomerTask
          - NodeInstance
          - PlatformInstance
          - Schedule
          - User
          - LoggingConfig
          - RuntimeConfigKey
          - HAConfig
          - HABackup
          - ScheduledScript
          - SupportBundle
          - GFlags
          example: User
          readOnly: true
          type: string
        targetID:
          description: Target ID
          readOnly: true
          type: string
        taskUUID:
          description: Task UUID
          format: uuid
          readOnly: true
          type: string
        timestamp:
          format: date-time
          type: string
        userEmail:
          description: User Email
          readOnly: true
          type: string
        userUUID:
          description: User UUID
          format: uuid
          readOnly: true
          type: string
      required:
      - auditID
      - timestamp
      type: object
    Audit_3:
      description: Audit logging for requests and responses
      example:
        auditID: 0
        targetID: targetID
        additionalDetails: '{}'
        taskUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
        target: User
        userAddress: userAddress
        apiMethod: GET
        customerUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
        payload: '{}'
        action: Create User
        apiCall: /api/v1/customers/<496fdea8-df25-11eb-ba80-0242ac130004>/providers
        userEmail: userEmail
        userUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
        timestamp: 2022-12-12 13:07:18+00:00
      properties:
        action:
          description: Action
          enum:
          - Set
          - Create
          - Edit
          - Update
          - Delete
          - Register
          - Refresh
          - Upload
          - Upgrade
          - Import
          - Attach
          - Pause
          - Resume
          - Restart
          - Abort
          - Retry
          - Rollback
          - Restore
          - Alter
          - Drop
          - Stop
          - Validate
          - Acknowledge
          - SyncXClusterConfig
          - SyncDrConfig
          - Failover
          - Switchover
          - Login
          - ApiLogin
          - Promote
          - Bootstrap
          - Configure
          - UpdateOptions
          - UpdateLoadBalancerConfig
          - RefreshPricing
          - UpgradeSoftware
          - FinalizeUpgrade
          - RollbackUpgrade
          - UpgradeGFlags
          - CreateTelemetryConfig
          - DeleteTelemetryConfig
          - CreatePACollectorConfig
          - EditPACollectorConfig
          - DeletePACollectorConfig
          - PACollectorRegister
          - PACollectorUnregister
          - UpgradeKubernetesOverrides
          - UpgradeCerts
          - UpgradeTLS
          - UpgradeVmImage
          - UpgradeSystemd
          - RebootUniverse
          - ResizeNode
          - AddMetrics
          - CreateKubernetes
          - SetupDocker
          - RetrieveKmsKey
          - RemoveKmsKeyReferenceHistory
          - UpsertCustomerFeatures
          - CreateSelfSignedCert
          - UpdateEmptyCustomerCertificate
          - GetRootCertificate
          - AddClientCertificate
          - SetDBCredentials
          - CreateUserInDB
          - CreateRestrictedUserInDB
          - DropUserInDB
          - SetHelm3Compatible
          - SetBackupFlag
          - SetUniverseKey
          - ResetUniverseVersion
          - ConfigUniverseAlert
          - ToggleTls
          - ModifyAuditLogging
          - ModifyQueryLogging
          - ConfigureMetricsExport
          - TlsConfigUpdate
          - UpdateDiskSize
          - CreateCluster
          - DeleteCluster
          - CreateAllClusters
          - UpdatePrimaryCluster
          - UpdateReadOnlyCluster
          - CreateReadOnlyCluster
          - DeleteReadOnlyCluster
          - RunYsqlQuery
          - BulkImport
          - CreateBackup
          - RestoreBackup
          - CreateSingleTableBackup
          - CreateMultiTableBackup
          - CreateBackupSchedule
          - CreatePitrConfig
          - UpdatePitrConfig
          - RestoreSnapshotSchedule
          - DeletePitrConfig
          - EditBackupSchedule
          - StartPeriodicBackup
          - StopPeriodicBackup
          - DetachedNodeInstanceAction
          - NodeInstanceAction
          - DeleteBackupSchedule
          - ChangeUserRole
          - ChangeUserPassword
          - SetSecurity
          - GenerateApiToken
          - ResetSlowQueries
          - ExternalScriptSchedule
          - StopScheduledScript
          - UpdateScheduledScript
          - CreateInstanceType
          - DeleteInstanceType
          - GetUniverseResources
          - ThirdpartySoftwareUpgrade
          - CreateTableSpaces
          - CreateHook
          - DeleteHook
          - UpdateHook
          - CreateHookScope
          - DeleteHookScope
          - AddHook
          - RemoveHook
          - RotateAccessKey
          - CreateAndRotateAccessKey
          - RunHook
          - RunApiTriggeredHooks
          - AddNodeAgent
          - UpdateNodeAgent
          - DeleteNodeAgent
          - DisableYbc
          - UpgradeYbc
          - InstallYbc
          - UpgradeYbcGFlags
          - SetThrottleParams
          - CreateImageBundle
          - DeleteImageBundle
          - EditImageBundle
          - Detach
          - RollbackDetach
          - DeleteAttachDetachMetadata
          - Unlock
          - LdapUniverseSync
          - UpdateProxyConfig
          - ProvisionUniverseNodes
          - CloneNamespace
          - UpdateAdditionalServicesState
          - KubernetesToggleImmutableYbc
          - OperatorImportUniverse
          - RunScript
          - CreateFileCollection
          - DownloadFileCollection
          - DeleteFileCollection
          example: Create User
          readOnly: true
          type: string
        additionalDetails:
          description: Additional Details
          properties: {}
          readOnly: true
          type: object
          example: {}
        apiCall:
          description: API call
          example: /api/v1/customers/<496fdea8-df25-11eb-ba80-0242ac130004>/providers
          readOnly: true
          type: string
        apiMethod:
          description: API method
          example: GET
          readOnly: true
          type: string
        auditID:
          description: Audit UID
          format: int64
          readOnly: true
          type: integer
          example: 1000
        customerUUID:
          description: Customer UUID
          format: uuid
          readOnly: true
          type: string
          example: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
        payload:
          description: Audit UUID
          properties: {}
          readOnly: true
          type: object
          example: {}
        target:
          description: Target
          enum:
          - Session
          - CloudProvider
          - Region
          - AvailabilityZone
          - CustomerConfig
          - KMSConfig
          - Customer
          - Release
          - Certificate
          - CustomCACertificate
          - Alert
          - AlertTemplateSettings
          - AlertTemplateVariables
          - AlertChannel
          - AlertChannelTemplates
          - AlertDestination
          - MaintenanceWindow
          - AccessKey
          - Universe
          - XClusterConfig
          - DrConfig
          - Table
          - Backup
          - CustomerTask
          - NodeInstance
          - PlatformInstance
          - Schedule
          - User
          - LoggingConfig
          - RuntimeConfigKey
          - HAConfig
          - HABackup
          - ScheduledScript
          - SupportBundle
          - TelemetryProvider
          - PACollector
          - GFlags
          - Hook
          - HookScope
          - NodeAgent
          - CustomerLicense
          - PerformanceRecommendation
          - PerformanceAdvisorSettings
          - PerformanceAdvisorRun
          - Role
          - RoleBinding
          - GroupMapping
          - JobSchedule
          - ContinuousBackup
          - IsolatedBackup
          example: User
          readOnly: true
          type: string
        targetID:
          description: Target ID
          readOnly: true
          type: string
          example: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
        taskUUID:
          description: Task UUID
          format: uuid
          readOnly: true
          type: string
          example: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
        timestamp:
          description: The task creation time.
          example: 2022-12-12 13:07:18+00:00
          format: date-time
          readOnly: true
          type: string
        userAddress:
          description: User IP Address
          readOnly: true
          type: string
          example: example-userAddress
        userEmail:
          description: User Email
          readOnly: true
          type: string
          example: admin@example.com
        userUUID:
          description: User UUID
          format: uuid
          readOnly: true
          type: string
          example: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
      type: object
    Audit_4:
      description: Audit logging for requests and responses
      example:
        auditID: 0
        targetID: targetID
        additionalDetails: '{}'
        taskUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
        target: User
        userAddress: userAddress
        apiMethod: GET
        customerUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
        payload: '{}'
        action: Create User
        apiCall: /api/v1/customers/<496fdea8-df25-11eb-ba80-0242ac130004>/providers
        userEmail: userEmail
        userUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
        timestamp: 2022-12-12 13:07:18+00:00
      properties:
        action:
          description: Action
          enum:
          - Set
          - Create
          - Edit
          - Update
          - Delete
          - Register
          - Refresh
          - Upload
          - Upgrade
          - Import
          - Attach
          - Pause
          - Resume
          - Restart
          - Abort
          - Retry
          - Rollback
          - Restore
          - Alter
          - Drop
          - Stop
          - Validate
          - Acknowledge
          - SyncXClusterConfig
          - SyncDrConfig
          - Failover
          - Switchover
          - Login
          - ApiLogin
          - Promote
          - Bootstrap
          - Configure
          - UpdateOptions
          - UpdateLoadBalancerConfig
          - RefreshPricing
          - UpgradeSoftware
          - FinalizeUpgrade
          - RollbackUpgrade
          - UpgradeGFlags
          - CreateTelemetryConfig
          - DeleteTelemetryConfig
          - CreatePACollectorConfig
          - EditPACollectorConfig
          - DeletePACollectorConfig
          - PACollectorRegister
          - PACollectorUnregister
          - UpgradeKubernetesOverrides
          - UpgradeCerts
          - UpgradeTLS
          - UpgradeVmImage
          - UpgradeSystemd
          - RebootUniverse
          - ResizeNode
          - AddMetrics
          - CreateKubernetes
          - SetupDocker
          - RetrieveKmsKey
          - RemoveKmsKeyReferenceHistory
          - UpsertCustomerFeatures
          - CreateSelfSignedCert
          - UpdateEmptyCustomerCertificate
          - GetRootCertificate
          - AddClientCertificate
          - SetDBCredentials
          - CreateUserInDB
          - CreateRestrictedUserInDB
          - DropUserInDB
          - SetHelm3Compatible
          - SetBackupFlag
          - SetUniverseKey
          - ResetUniverseVersion
          - ConfigUniverseAlert
          - ToggleTls
          - ModifyAuditLogging
          - ModifyQueryLogging
          - ConfigureMetricsExport
          - TlsConfigUpdate
          - UpdateDiskSize
          - CreateCluster
          - DeleteCluster
          - CreateAllClusters
          - UpdatePrimaryCluster
          - UpdateReadOnlyCluster
          - CreateReadOnlyCluster
          - DeleteReadOnlyCluster
          - RunYsqlQuery
          - BulkImport
          - CreateBackup
          - RestoreBackup
          - CreateSingleTableBackup
          - CreateMultiTableBackup
          - CreateBackupSchedule
          - CreatePitrConfig
          - UpdatePitrConfig
          - RestoreSnapshotSchedule
          - DeletePitrConfig
          - EditBackupSchedule
          - StartPeriodicBackup
          - StopPeriodicBackup
          - DetachedNodeInstanceAction
          - NodeInstanceAction
          - DeleteBackupSchedule
          - ChangeUserRole
          - ChangeUserPassword
          - SetSecurity
          - GenerateApiToken
          - ResetSlowQueries
          - ExternalScriptSchedule
          - StopScheduledScript
          - UpdateScheduledScript
          - CreateInstanceType
          - DeleteInstanceType
          - GetUniverseResources
          - ThirdpartySoftwareUpgrade
          - CreateTableSpaces
          - CreateHook
          - DeleteHook
          - UpdateHook
          - CreateHookScope
          - DeleteHookScope
          - AddHook
          - RemoveHook
          - RotateAccessKey
          - CreateAndRotateAccessKey
          - RunHook
          - RunApiTriggeredHooks
          - AddNodeAgent
          - UpdateNodeAgent
          - DeleteNodeAgent
          - DisableYbc
          - UpgradeYbc
          - InstallYbc
          - UpgradeYbcGFlags
          - SetThrottleParams
          - CreateImageBundle
          - DeleteImageBundle
          - EditImageBundle
          - Detach
          - RollbackDetach
          - DeleteAttachDetachMetadata
          - Unlock
          - LdapUniverseSync
          - UpdateProxyConfig
          - ProvisionUniverseNodes
          - CloneNamespace
          - UpdateAdditionalServicesState
          - KubernetesToggleImmutableYbc
          - OperatorImportUniverse
          - RunScript
          - CreateFileCollection
          - DownloadFileCollection
          - DeleteFileCollection
          example: Create User
          readOnly: true
          type: string
        additionalDetails:
          description: Additional Details
          properties: {}
          readOnly: true
          type: object
          example: {}
        apiCall:
          description: API call
          example: /api/v1/customers/<496fdea8-df25-11eb-ba80-0242ac130004>/providers
          readOnly: true
          type: string
        apiMethod:
          description: API method
          example: GET
          readOnly: true
          type: string
        auditID:
          description: Audit UID
          format: int64
          readOnly: true
          type: integer
          example: 1000
        customerUUID:
          description: Customer UUID
          format: uuid
          readOnly: true
          type: string
          example: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
        payload:
          description: Audit UUID
          properties: {}
          readOnly: true
          type: object
          example: {}
        target:
          description: Target
          enum:
          - Session
          - CloudProvider
          - Region
          - AvailabilityZone
          - CustomerConfig
          - KMSConfig
          - Customer
          - Release
          - Certificate
          - CustomCACertificate
          - Alert
          - AlertTemplateSettings
          - AlertTemplateVariables
          - AlertChannel
          - AlertChannelTemplates
          - AlertDestination
          - MaintenanceWindow
          - AccessKey
          - Universe
          - XClusterConfig
          - DrConfig
          - Table
          - Backup
          - CustomerTask
          - NodeInstance
          - PlatformInstance
          - Schedule
          - User
          - LoggingConfig
          - RuntimeConfigKey
          - HAConfig
          - HABackup
          - ScheduledScript
          - SupportBundle
          - TelemetryProvider
          - PACollector
          - GFlags
          - Hook
          - HookScope
          - NodeAgent
          - CustomerLicense
          - PerformanceRecommendation
          - PerformanceAdvisorSettings
          - PerformanceAdvisorRun
          - Role
          - RoleBinding
          - GroupMapping
          - JobSchedule
          - ContinuousBackup
          - IsolatedBackup
          example: User
          readOnly: true
          type: string
        targetID:
          description: Target ID
          readOnly: true
          type: string
          example: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
        taskUUID:
          description: Task UUID
          format: uuid
          readOnly: true
          type: string
          example: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
        timestamp:
          description: The task creation time.
          example: 2022-12-12 13:07:18+00:00
          format: date-time
          readOnly: true
          type: string
        userAddress:
          description: User IP Address
          readOnly: true
          type: string
          example: example-userAddress
        userEmail:
          description: User Email
          readOnly: true
          type: string
          example: admin@example.com
        userUUID:
          description: User UUID
          format: uuid
          readOnly: true
          type: string
          example: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
      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