/2016-07/deployments/:id/password

Update your deployment's master password, if permitted.

📘

For security and compliance reasons, master password updates are not permitted on certain deployments and deployment types, such as MongoDB, Elasticsearch and Scylla.

Will respond with information about the password change recipe that is being run.

A Recipe is a process, or processes, which performs a task; in this case, that task is changing the deployment's master password. When the API returns a recipe, it gives the id and status information about that process and its current status. The recipe runs asynchronously.

By querying the recipe endpoint - /2016-07/recipes/:id with the returned id, you can get updates on the status of the task being performed. Completion is denoted by the status field being returned as completed.

Language
Authentication
Header
Click Try It! to start a request and see the response here!