---
title: "Rotate a database user's password"
url: https://docs.corefinity.com/api/reference/database/rotate-site-database-user-password
type: endpoint
last_updated: 2026-11-13
feature: database
related:
  - https://docs.corefinity.com/guides/sites/database/database-users.md
  - https://docs.corefinity.com/mcp/tools/corestack_external_db_user_password_rotate.md
---
# 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.

```http
POST /api/corestack/sites/{site}/database/users/{username}/password
```

- Scope: `write`
- Two-factor: required on your account (all)
- Rate limit: 20 a minute
- Long-running: answers with an operation to poll
- Try it in the console: off. It has not been cleared for the console. Copy the request and run it yourself when you are sure.

## Path parameters

- `site` (integer, required): The id of a site row. A website's production site and each of its environments has its own id. Digits only.
- `username` (string, required): A database user's name, as the database details list it.

## Body

- `password` (object, required)
  - `mode` (string, required): `generate`: a 24-character password, revealed once. `set`: your own, in `value`. One of `generate`, `set`.
  - `value` (string): Your own password, with `mode: set`. 12 to 64 printable characters, without spaces, quotes, backticks or backslashes.

## Request

### curl

```bash
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"
    }
  }'
```

### PHP

```php
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();
```

### Node

```javascript
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);
```

### Python

```python
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
```

## Responses

### 202 The password is being changed. Follow `operation.id` until it completes.

```json
{
  "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"
  }
}
```

### 401 No token, or a token that is not valid.

```json
{
  "message": "Unauthenticated."
}
```

### 403 The token lacks the scope (`scope_required`, with the `scope` to use), your company requires two-factor authentication and you have not set it up, or your account has no company that can use Managed Clusters, for example because the company was closed (`company_unavailable` or `company_not_enabled`, whichever the route checks first). For Managed Clusters routes; any other route uses `ForbiddenScopeOrTwoFactor`.

```json
{
  "code": "company_unavailable",
  "message": "Your company is unavailable.",
  "reason": "company_unavailable"
}
```

### 404 The site id does not exist or is a site you cannot change, the feature is not on for your company (`feature_off`), or no user of that name on this environment can be changed from here (`user_not_found`): an unknown name, the site's own `application` login and the platform's own accounts all answer the same body.

```json
{
  "code": "feature_off",
  "message": "Not found.",
  "reason": "feature_off"
}
```

### 409 The change was refused because of the site's state. `reason` says why: `deleted`, `provisioning`, `busy` (another change is running), `restore_running`, `removed` or `managed_elsewhere`.

```json
{
  "code": "busy",
  "message": "Another change to this site is in progress. Wait for it to finish.",
  "reason": "busy"
}
```

### 422 The password is missing or refused (`invalid`, with `field` and `errors`).

```json
{
  "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"
}
```

### 429 Too many requests (`rate_limited`). Wait for the number of seconds in `Retry-After`, which `retry_after_seconds` repeats.

```json
{
  "code": "rate_limited",
  "message": "Too many requests. Try again in 60 seconds.",
  "reason": "rate_limited",
  "retry_after_seconds": 60
}
```

### 503 Corefinity has switched changes to database users off for the moment (`switched_off`). Try again later.

```json
{
  "code": "switched_off",
  "message": "Database users can't be changed just now. Try again later.",
  "reason": "switched_off"
}
```

## If it is refused

| Status | Reason | What to do |
|---|---|---|
| 401 |  | 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. |

## The same task elsewhere

- Guide: [Database users](https://docs.corefinity.com/guides/sites/database/database-users.md)
- MCP tool: [`corestack_external_db_user_password_rotate`](https://docs.corefinity.com/mcp/tools/corestack_external_db_user_password_rotate.md)
