Auditing Db Conns

Get database auditing settings {#get-cluster-audit-db-conns}

GET /v1/cluster/auditing/db_conns

Gets the configuration settings for [auditing database connections]({{< relref "/operate/rs/security/audit-events" >}}).

Required permissions

Request {#get-request}

Example HTTP request

GET /v1/cluster/auditing/db_conns 

Request headers

Response {#get-response}

Returns a [database connection auditing configuration object]({{< relref "/operate/rs/references/rest-api/objects/db-conns-auditing-config" >}}).

Example JSON body

{
    "audit_address": "127.0.0.1",
    "audit_port": 12345,
    "audit_protocol": "TCP",
    "audit_reconnect_interval": 1,
    "audit_reconnect_max_attempts": 0
}

Error codes {#get-error-codes}

When errors are reported, the server may return a JSON object with error_code and message fields that provide additional information. The following are possible error_code values:

Status codes {#get-status-codes}

Update database auditing {#put-cluster-audit-db-conns}

PUT /v1/cluster/auditing/db_conns

Updates the configuration settings for [auditing database connections]({{< relref "/operate/rs/security/audit-events" >}}).

Required permissions

Request {#put-request}

Example HTTP request

PUT /v1/cluster/auditing/db_conns

Example JSON body

{
    "audit_protocol": "TCP",
    "audit_address": "127.0.0.1",
    "audit_port": 12345,
    "audit_reconnect_interval": 1,
    "audit_reconnect_max_attempts": 0
}

Request headers

Request body

Include a [database connection auditing configuration object]({{< relref "/operate/rs/references/rest-api/objects/db-conns-auditing-config" >}}) with updated fields in the request body.

Response {#put-response}

Returns the updated [database connection auditing configuration object]({{< relref "/operate/rs/references/rest-api/objects/db-conns-auditing-config" >}}).

Example JSON body

{
    "audit_address": "127.0.0.1",
    "audit_port": 12345,
    "audit_protocol": "TCP",
    "audit_reconnect_interval": 1,
    "audit_reconnect_max_attempts": 0
}

Error codes {#put-error-codes}

When errors are reported, the server may return a JSON object with error_code and message fields that provide additional information. The following are possible error_code values:

Status codes {#put-status-codes}

Delete database auditing settings {#delete-cluster-audit-db-conns}

DELETE /v1/cluster/auditing/db_conns

Resets the configuration settings for [auditing database connections]({{< relref "/operate/rs/security/audit-events" >}}).

Required permissions

Request {#delete-request}

Example HTTP request

DELETE /v1/cluster/auditing/db_conns 

Request headers

Response {#delete-response}

Returns a status code that indicates whether the database connection auditing settings reset successfully or failed to reset.

Error codes {#delete-error-codes}

When errors are reported, the server may return a JSON object with error_code and message fields that provide additional information. The following are possible error_code values:

Status codes {#delete-status-codes}