Rotate a Secret
rotate_secretReplace a secret's values and restart the workloads that use it, since they read secrets only when they start. Anything outside Control Plane that holds the old values stops working. Values Control Plane generated get new random ones now, which nobody sees. Values the user supplies get a Console link where the user enters the new ones, then a second call with userSaved: true restarts the workloads. Database credentials from add_database come back with the steps, since the database keeps its own password. No input accepts a value. preview true shows what would change and which workloads would restart.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| org | No | Organization slug. | |
| name | Yes | The secret to rotate. | |
| preview | No | true: report what a rotation would change and which workloads it would restart, and change nothing. | |
| userSaved | No | Only after the user saved new values in the Console for a secret whose values they supply: restarts the workloads that use it, so they read the new values. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| ok | Yes | ||
| data | No | The full result. Read this, not only the summary. | |
| details | No | ||
| summary | Yes | ||
| nextSteps | No |