{
  "id": "passwords",
  "title": "Database passwords requests",
  "url": "https://redis.io/docs/latest/operate/rs/7.8/references/rest-api/requests/bdbs/passwords/",
  "summary": "Database password requests",
  "content": "\n| Method | Path | Description |\n|--------|------|-------------|\n| [PUT](#put-bdbs-password) | `/v1/bdbs/{uid}/passwords` | Update database password |\n| [POST](#post-bdbs-password) | `/v1/bdbs/{uid}/passwords` | Add database password |\n| [DELETE](#delete-bdbs-password) | `/v1/bdbs/{uid}/passwords` | Delete database password |\n\n## Update database password {#put-bdbs-password}\n\n\tPUT /v1/bdbs/{int: uid}/passwords\n\nSet a single password for the bdb's default user (i.e., for `AUTH`\u0026nbsp;`\u003cpassword\u003e` authentications).\n\n#### Required permissions\n\n| Permission name |\n|-----------------|\n| [update_bdb]() |\n\n### Request {#put-request} \n\n#### Example HTTP request\n\n\tPUT /v1/bdbs/1/passwords \n\n#### Example JSON body\n\n```json\n{\n    \"password\": \"new password\"\n}\n```\n\nThe above request resets the password of the bdb to ‘new password’.\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\n#### URL parameters\n\n| Field | Type | Description |\n|-------|------|-------------|\n| uid | integer | The unique ID of the database to update the password. |\n\n\n#### Request body\n\n| Field | Type | Description |\n|-------|------|-------------|\n| password | string | New password |\n\n### Response {#put-response} \n\nReturns a status code that indicates password update success or failure.\n\n### Status codes {#put-status-codes} \n\n| Code | Description |\n|------|-------------|\n| [200 OK](http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.2.1) | The password was changed. |\n| [404 Not Found](http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.5) | A nonexistent database. |\n| [406 Not Acceptable](http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.7) | Invalid configuration parameters provided. |\n\n## Add database password {#post-bdbs-password}\n\n\tPOST /v1/bdbs/{int: uid}/passwords\n\nAdd a password to the bdb's default user (i.e., for `AUTH`\u0026nbsp;`\u003cpassword\u003e` authentications).\n\n#### Required permissions\n\n| Permission name |\n|-----------------|\n| [update_bdb]() |\n\n### Request {#post-request} \n\n#### Example HTTP request\n\n\tPOST /v1/bdbs/1/passwords \n\n#### Example JSON body\n\n```json\n{\n    \"password\": \"password to add\"\n}\n```\n\nThe above request adds a password to the bdb.\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#### URL parameters\n\n| Field | Type | Description |\n|-------|------|-------------|\n| uid | integer | The unique ID of the database to add password. |\n\n#### Request body\n\n| Field | Type | Description |\n|-------|------|-------------|\n| password | string | Password to add |\n\n### Response {#post-response} \n\nReturns a status code that indicates password creation success or failure.\n\n### Status codes {#post-status-codes} \n\n| Code | Description |\n|------|-------------|\n| [200 OK](http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.2.1) | The password was added. |\n| [404 Not Found](http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.5) | A nonexistent database. |\n| [406 Not Acceptable](http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.7) | Invalid configuration parameters provided. |\n\n## Delete database password {#delete-bdbs-password}\n\n\tDELETE /v1/bdbs/{int: uid}/passwords\n\nDelete a password from the bdb's default user (i.e., for `AUTH`\u0026nbsp;`\u003cpassword\u003e` authentications).\n\n#### Required permissions\n\n| Permission name |\n|-----------------|\n| [update_bdb]() |\n\n### Request {#delete-request} \n\n#### Example HTTP request\n\n\tDELETE /v1/bdbs/1/passwords \n\n#### Example JSON body\n\n```json\n{\n    \"password\": \"password to delete\"\n}\n```\n\nThe above request deletes a password from the bdb.\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#### URL parameters\n\n| Field | Type | Description |\n|-------|------|-------------|\n| uid | integer | The unique ID of the database to delete password. |\n\n#### Request body\n\n| Field | Type | Description |\n|-------|------|-------------|\n| password | string | Password to delete |\n\n### Response {#delete-response} \n\nReturns a status code that indicates password deletion success or failure.\n\n### Status codes {#delete-status-codes} \n\n| Code | Description |\n|------|-------------|\n| [200 OK](http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.2.1) | The password was deleted. |\n| [404 Not Found](http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.5) | A nonexistent database. |\n| [406 Not Acceptable](http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.7) | Invalid configuration parameters provided. |\n",
  "tags": ["docs","operate","rs"],
  "last_updated": "2026-04-01T08:10:08-05:00"
}