Database passwords requests
        Database password requests
  
  
    
      
        
        
        
        
        
        
        
           
        
        
        
          
           
          
            
            
          
          | Redis Enterprise Software | 
    
    
      
    
  
 
        
        
          
          
          
            
          
          
          
            
            
          
            
            
          
            
            
          
            
            
          
            
            
          
            
              
  This documentation applies to version 7.22.
 
            
            
          
            
            
          
        
        
        
  
      
          | Method | Path | Description | 
  
  
      
          | PUT | /v1/bdbs/{uid}/passwords | Update database password | 
      
          | POST | /v1/bdbs/{uid}/passwords | Add database password | 
      
          | DELETE | /v1/bdbs/{uid}/passwords | Delete database password | 
  
  Update database 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
  
  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’.
  
      
          | Key | Value | Description | 
  
  
      
          | Host | cnm.cluster.fqdn | Domain name | 
      
          | Accept | application/json | Accepted media type | 
  
  URL parameters
  
  
      
          | Field | Type | Description | 
  
  
      
          | uid | integer | The unique ID of the database to update the password. | 
  
  Request body
  
  
      
          | Field | Type | Description | 
  
  
      
          | password | string | New password | 
  
  Response
  
Returns a status code that indicates password update success or failure.
  Status codes
  
  Add database 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
  
  Example HTTP request
  
POST /v1/bdbs/1/passwords 
  Example JSON body
  
{
    "password": "password to add"
}
The above request adds a password to the bdb.
  
      
          | Key | Value | Description | 
  
  
      
          | Host | cnm.cluster.fqdn | Domain name | 
      
          | Accept | application/json | Accepted media type | 
  
  URL parameters
  
  
      
          | Field | Type | Description | 
  
  
      
          | uid | integer | The unique ID of the database to add password. | 
  
  Request body
  
  
      
          | Field | Type | Description | 
  
  
      
          | password | string | Password to add | 
  
  Response
  
Returns a status code that indicates password creation success or failure.
  Status codes
  
  Delete database 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
  
  Example HTTP request
  
DELETE /v1/bdbs/1/passwords 
  Example JSON body
  
{
    "password": "password to delete"
}
The above request deletes a password from the bdb.
  
      
          | Key | Value | Description | 
  
  
      
          | Host | cnm.cluster.fqdn | Domain name | 
      
          | Accept | application/json | Accepted media type | 
  
  URL parameters
  
  
      
          | Field | Type | Description | 
  
  
      
          | uid | integer | The unique ID of the database to delete password. | 
  
  Request body
  
  
      
          | Field | Type | Description | 
  
  
      
          | password | string | Password to delete | 
  
  Response
  
Returns a status code that indicates password deletion success or failure.
  Status codes