Auditing database connections requests

Auditing database connections requests

Get database auditing settings

GET /v1/cluster/auditing/db_conns

Gets the configuration settings for auditing database connections.

Required permissions

Request

Example HTTP request

GET /cluster/auditing/db_conns 

Request headers

Response

Returns a database connection auditing configuration object.

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

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

Update database auditing

PUT /v1/cluster/auditing/db_conns

Updates the configuration settings for auditing database connections.

Required permissions

Request

Example HTTP request

PUT /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 with updated fields in the request body.

Response

Returns the updated database connection auditing configuration object.

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

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 database auditing settings

DELETE /v1/cluster/auditing/db_conns

Resets the configuration settings for auditing database connections.

Required permissions

Request

Example HTTP request

DELETE /cluster/auditing/db_conns 

Request headers

Response

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

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