{
  "id": "auditing-db-conns",
  "title": "Auditing database connections requests",
  "url": "https://redis.io/docs/latest/operate/rs/7.8/references/rest-api/requests/cluster/auditing-db-conns/",
  "summary": "Auditing database connections requests",
  "content": "\n| Method | Path | Description |\n|--------|------|-------------|\n| [GET](#get-cluster-audit-db-conns) | `/v1/cluster/auditing/db_conns` | Get database connection auditing settings |\n| [PUT](#put-cluster-audit-db-conns) | `/v1/cluster/auditing/db_conns` | Update database connection auditing settings |\n| [DELETE](#delete-cluster-audit-db-conns) | `/v1/cluster/auditing/db_conns` | Delete database connection auditing settings |\n\n## Get database auditing settings {#get-cluster-audit-db-conns}\n\n\tGET /v1/cluster/auditing/db_conns\n\nGets the configuration settings for [auditing database connections]().\n\n#### Required permissions\n\n| Permission name |\n|-----------------|\n| [view_cluster_info]() |\n\n### Request {#get-request} \n\n#### Example HTTP request\n\n\tGET /v1/cluster/auditing/db_conns \n\n\n#### Request headers\n\n| Key | Value | Description |\n|-----|-------|-------------|\n| Host | cnm.cluster.fqdn | Domain name |\n| Accept | application/json | Accepted media type |\n\n### Response {#get-response} \n\nReturns a [database connection auditing configuration object]().\n\n#### Example JSON body\n\n```json\n{\n    \"audit_address\": \"127.0.0.1\",\n    \"audit_port\": 12345,\n    \"audit_protocol\": \"TCP\",\n    \"audit_reconnect_interval\": 1,\n    \"audit_reconnect_max_attempts\": 0\n}\n```\n\n### Error codes {#get-error-codes} \n\nWhen 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:\n\n| Code | Description |\n|------|-------------|\n| db_conns_auditing_unsupported_by_capability | Not all nodes support DB Connections Auditing capability  | \n\n### Status codes {#get-status-codes} \n\n| Code | Description |\n|------|-------------|\n| [200 OK](https://www.rfc-editor.org/rfc/rfc9110.html#name-200-ok) | Success |\n| [406 Not Acceptable](https://www.rfc-editor.org/rfc/rfc9110.html#name-406-not-acceptable) | Feature not supported for all nodes |\n\n## Update database auditing {#put-cluster-audit-db-conns}\n\n\tPUT /v1/cluster/auditing/db_conns\n\nUpdates the configuration settings for [auditing database connections]().\n\n#### Required permissions\n\n| Permission name |\n|-----------------|\n| [update_cluster]() |\n\n### Request {#put-request} \n\n#### Example HTTP request\n\n\tPUT /v1/cluster/auditing/db_conns\n\n#### Example JSON body\n\n```json\n{\n    \"audit_protocol\": \"TCP\",\n    \"audit_address\": \"127.0.0.1\",\n    \"audit_port\": 12345,\n    \"audit_reconnect_interval\": 1,\n    \"audit_reconnect_max_attempts\": 0\n}\n```\n\n#### Request headers\n\n| Key | Value | Description |\n|-----|-------|-------------|\n| Host | cnm.cluster.fqdn | Domain name |\n| Accept | application/json | Accepted media type |\n\n#### Request body\n\nInclude a [database connection auditing configuration object]() with updated fields in the request body.\n\n### Response {#put-response} \n\nReturns the updated [database connection auditing configuration object]().\n\n#### Example JSON body\n\n```json\n{\n    \"audit_address\": \"127.0.0.1\",\n    \"audit_port\": 12345,\n    \"audit_protocol\": \"TCP\",\n    \"audit_reconnect_interval\": 1,\n    \"audit_reconnect_max_attempts\": 0\n}\n```\n\n### Error codes {#put-error-codes} \n\nWhen 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:\n\n| Code | Description |\n|------|-------------|\n| db_conns_auditing_unsupported_by_capability | Not all nodes support DB Connections Auditing capability  | \n\n### Status codes {#put-status-codes} \n\n| Code | Description |\n|------|-------------|\n| [200 OK](https://www.rfc-editor.org/rfc/rfc9110.html#name-200-ok) | Success |\n| [406 Not Acceptable](https://www.rfc-editor.org/rfc/rfc9110.html#name-406-not-acceptable) | Feature not supported for all nodes |\n\n## Delete database auditing settings {#delete-cluster-audit-db-conns}\n\n\tDELETE /v1/cluster/auditing/db_conns\n\nResets the configuration settings for [auditing database connections]().\n\n#### Required permissions\n\n| Permission name |\n|-----------------|\n| [update_cluster]() |\n\n### Request {#delete-request} \n\n#### Example HTTP request\n\n\tDELETE /v1/cluster/auditing/db_conns \n\n\n#### Request headers\n\n| Key | Value | Description |\n|-----|-------|-------------|\n| Host | cnm.cluster.fqdn | Domain name |\n| Accept | application/json | Accepted media type |\n\n### Response {#delete-response} \n\nReturns a status code that indicates whether the database connection auditing settings reset successfully or failed to reset.\n\n### Error codes {#delete-error-codes} \n\nWhen 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:\n\n| Code | Description |\n|------|-------------|\n| db_conns_audit_config_not_found | Unable to find the auditing configuration |\n| cannot_delete_audit_config_when_policy_enabled | Auditing cluster policy is 'enabled' when trying to delete the auditing configuration |\n| cannot_delete_audit_config_when_bdb_enabled | One of the databases has auditing configuration 'enabled' when trying to delete the auditing configuration |\n\n### Status codes {#delete-status-codes} \n\n| Code | Description |\n|------|-------------|\n| [200 OK](https://www.rfc-editor.org/rfc/rfc9110.html#name-200-ok) | Success |\n| [404 Not Found](https://www.rfc-editor.org/rfc/rfc9110.html#name-404-not-found) | Configuration not found |\n| [406 Not Acceptable](https://www.rfc-editor.org/rfc/rfc9110.html#name-406-not-acceptable) | Feature not supported for all nodes |\n",
  "tags": ["docs","operate","rs"],
  "last_updated": "2026-04-01T08:10:08-05:00"
}