Passwords

Update database password {#put-bdbs-password}

PUT /v1/bdbs/{int: uid}/passwords

Set a single password for the bdb's default user (i.e., for AUTH <password> authentications).

Required permissions

Request {#put-request}

Example HTTP request

PUT /v1/bdbs/1/passwords 

Example JSON body

{
    "password": "new password"
}

The above request resets the password of the bdb to ‘new password’.

Request headers

URL parameters

Request body

Response {#put-response}

Returns a status code that indicates password update success or failure.

Status codes {#put-status-codes}

Add database password {#post-bdbs-password}

POST /v1/bdbs/{int: uid}/passwords

Add a password to the bdb's default user (i.e., for AUTH <password> authentications).

Required permissions

Request {#post-request}

Example HTTP request

POST /v1/bdbs/1/passwords 

Example JSON body

{
    "password": "password to add"
}

The above request adds a password to the bdb.

Request headers

URL parameters

Request body

Response {#post-response}

Returns a status code that indicates password creation success or failure.

Status codes {#post-status-codes}

Delete database password {#delete-bdbs-password}

DELETE /v1/bdbs/{int: uid}/passwords

Delete a password from the bdb's default user (i.e., for AUTH <password> authentications).

Required permissions

Request {#delete-request}

Example HTTP request

DELETE /v1/bdbs/1/passwords 

Example JSON body

{
    "password": "password to delete"
}

The above request deletes a password from the bdb.

Request headers

URL parameters

Request body

Response {#delete-response}

Returns a status code that indicates password deletion success or failure.

Status codes {#delete-status-codes}