Rotate a database user's password
Gives the user a new password: a generated one, revealed once with the reveal endpoint, or one of your own. The old password stops working as soon as the operation completes; sessions that are open keep working until they reconnect. Try-it is off because whatever uses the old password stops connecting.
Path parameters
The id of a site row. A website's production site and each of its environments has its own id. Digits only. At least 1.
A database user's name, as the database details list it. Up to 128 characters.
Body
Fields
generate: a 24-character password, revealed once. set: your own, in value.
generatesetYour own password, with mode: set. 12 to 64 printable characters, without spaces, quotes, backticks or backslashes.
Returns
202 The password is being changed. Follow operation.id until it completes. Poll the operation until it finishes.
Fields of the 202 answer
A change the Control Panel is making or has made. A save or an action that starts work answers one in operation; read it again by id with GET / until status is completed or failed. Both answers have this shape; the few endpoints that answer a different one say so.
Fields
The cluster the operation runs on.
Why the operation failed, in plain words. Null unless status is failed.
A stable code for the failure.
True when the change applies without a maintenance window.
What the operation did differently on purpose. Empty when nothing.
Fields of each item
Who asked for the change.
Present on some site creations and copies.
Always null here. A one-time result is read once with the reveal endpoint.
nonependingavailableviewedWhat a retry needs first, if anything.
Who revealed a one-time result and when, when there was one.
siteclusterbatchThe website the operation belongs to. Null for a cluster's own operation.
Where a change is. completed and failed are final; every other status means the change is still running and blocks another change to the same site.
pendingcommittedrolling_outexecutingcompletedfailedThe key of the step the operation is at. Null once it has completed.
Fields of each item
One of done, current, todo, failed or skipped.
The kind of change, such as crons_change or redirects_change.
If it is refused
| Status | Reason | What to do |
|---|---|---|
401 | none | Send a valid token as Authorization: Bearer <token>. |
403 | company_unavailable | Your company is unavailable. |
403 | scope_required | Use a token with the scope named in scope. |
403 | two_factor_required | Turn on two-factor on your account, then send again. |
404 | feature_off | This feature is not on for your organisation yet. |
404 | user_not_found | There is no such database user on the environment. Read the users again. |
409 | busy | Another operation is running on the site. Wait for it to finish. |
409 | deleted | The site, environment or copy has been deleted, or is being deleted. Nothing can be changed on it. Restore a deleted site first if it can still be restored. |
409 | managed_elsewhere | This site is read-only here. Change it in the control panel that manages it. |
409 | provisioning | The site is still being created. Try again in a few minutes. |
422 | invalid | Fix the field named in field; errors says why. |
429 | rate_limited | Wait for the seconds in Retry-After. |
503 | switched_off | Corefinity has switched this action off for the moment. Try again later. |
Reasons are listed by name in Errors and refusals.
The same task elsewhere
curl -X POST https://manage.corefinity.com/api/corestack/sites/1042/database/users/reporting_ro/password \
-H "Authorization: Bearer $COREFINITY_TOKEN" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-d '{
"password": {
"mode": "generate"
}
}'use Illuminate\Support\Facades\Http;
$response = Http::withToken(env('COREFINITY_TOKEN'))
->acceptJson()
->post('https://manage.corefinity.com/api/corestack/sites/1042/database/users/reporting_ro/password', [
'password' => [
'mode' => 'generate',
],
]);
$data = $response->json();const res = await fetch('https://manage.corefinity.com/api/corestack/sites/1042/database/users/reporting_ro/password', {
method: 'POST',
headers: {
Authorization: `Bearer ${process.env.COREFINITY_TOKEN}`,
Accept: 'application/json',
'Content-Type': 'application/json',
},
body: JSON.stringify({
password: {
mode: 'generate',
},
}),
});
// An answer with no body (204) has nothing to parse.
const text = await res.text();
const data = text && JSON.parse(text);import os
import requests
res = requests.post(
"https://manage.corefinity.com/api/corestack/sites/1042/database/users/reporting_ro/password",
headers={
"Authorization": f"Bearer {os.environ['COREFINITY_TOKEN']}",
"Accept": "application/json",
},
json={
"password": {
"mode": "generate",
},
},
)
data = res.json() if res.content else None{
"operation": {
"applied_at": "2026-11-03T09:16:40Z",
"can_retry": false,
"cluster": {
"id": 1017,
"name": "Northwind UK 1"
},
"committed_at": null,
"completed_at": null,
"created_at": "2026-11-03T09:16:40Z",
"environment": {
"env_id": "rs-northwind-harbourandfinch-example-com",
"hostname": "harbourandfinch-example-com.northwind.cfstack.example.net",
"id": 1042,
"name": "Production",
"role": "production",
"role_label": "Production",
"slug": "production"
},
"error": null,
"failure_reason": null,
"from_version": null,
"hot": false,
"id": 5120,
"install": null,
"label": "Saved",
"notes": [],
"parent_operation_id": null,
"requested_by": {
"id": 2012,
"name": "Daniel Reyes"
},
"reset_target": null,
"result": null,
"result_state": "none",
"retried_by_operation_id": null,
"retries_operation_id": null,
"retry_requires": null,
"revealed": null,
"scope": "site",
"site": {
"domain": "harbourandfinch.example.com",
"id": 1042
},
"status": "executing",
"status_label": "Saving the change",
"step": "saved",
"steps": [
{
"key": "saved",
"label": "Saved",
"state": "current"
},
{
"key": "applied",
"label": "Applied in the database",
"state": "todo"
}
],
"subject": null,
"summary": "Password of reporting_ro rotated",
"to_version": null,
"type": "db_user_change",
"type_label": "Database users"
}
}{
"message": "Unauthenticated."
}{
"code": "company_unavailable",
"message": "Your company is unavailable.",
"reason": "company_unavailable"
}{
"code": "feature_off",
"message": "Not found.",
"reason": "feature_off"
}{
"code": "busy",
"message": "Another change to this site is in progress. Wait for it to finish.",
"reason": "busy"
}{
"code": "invalid",
"errors": {
"password.value": [
"Use 12 to 64 printable characters, without spaces, quotes or backslashes."
]
},
"field": "password.value",
"message": "Use 12 to 64 printable characters, without spaces, quotes or backslashes.",
"reason": "invalid"
}{
"code": "rate_limited",
"message": "Too many requests. Try again in 60 seconds.",
"reason": "rate_limited",
"retry_after_seconds": 60
}{
"code": "switched_off",
"message": "Database users can't be changed just now. Try again later.",
"reason": "switched_off"
}Try it is off for this endpointIt has not been cleared for the console. Copy the request and run it yourself when you are sure.