---
title: "Reset an administrator's password"
url: https://docs.corefinity.com/api/reference/sites/reset-site-admin-login
type: endpoint
last_updated: 2026-11-13
feature: functions
related:
  - https://docs.corefinity.com/guides/sites/create-and-manage/platform-tools.md
---
# Reset an administrator's password

Sets a new password for an administrator of a WordPress, Magento 2 or Shopware site and answers it once. Leave
`username` out to reset the administrator the site's current database was created with. The reset runs as one of
the site's platform tools, so its limits and refusals are a tool run's.

```http
POST /api/corestack/sites/{site}/admin-login/reset
```

- Scope: `exec`
- Two-factor: required on your account (all)
- Rate limit: 20 a minute
- Try it in the console: off. It runs commands on a live site. 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.

## Body

- `confirm` (boolean, required): Always `true`: the reset replaces the password. Left out or false, the request is refused `422` on `confirm`.
- `username` (string or null): The administrator to reset. Left out, the one the site's current database was created with. On a WordPress or Magento 2 site, up to 60 letters, digits, `_`, `.`, `@`, `+` or `-`, never starting with `+` or `-`. On a Shopware site, up to 32 of the same characters, never starting with `@`, `+` or `-`. Anything else is refused `422` on `username`.

## Request

### curl

```bash
curl -X POST https://manage.corefinity.com/api/corestack/sites/1042/admin-login/reset \
  -H "Authorization: Bearer $COREFINITY_TOKEN" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{
    "confirm": true
  }'
```

### PHP

```php
use Illuminate\Support\Facades\Http;

$response = Http::withToken(env('COREFINITY_TOKEN'))
    ->acceptJson()
    ->post('https://manage.corefinity.com/api/corestack/sites/1042/admin-login/reset', [
        'confirm' => true,
    ]);

$data = $response->json();
```

### Node

```javascript
const res = await fetch('https://manage.corefinity.com/api/corestack/sites/1042/admin-login/reset', {
  method: 'POST',
  headers: {
    Authorization: `Bearer ${process.env.COREFINITY_TOKEN}`,
    Accept: 'application/json',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    confirm: true,
  }),
});

// 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/admin-login/reset",
    headers={
        "Authorization": f"Bearer {os.environ['COREFINITY_TOKEN']}",
        "Accept": "application/json",
    },
    json={
        "confirm": True,
    },
)

data = res.json() if res.content else None
```

## Responses

### 200 The password was reset. `secret` holds it, once.

```json
{
  "command": {
    "blocked_until_verified": false,
    "duration_ms": 840,
    "error": null,
    "exit_code": 0,
    "finished_at": "2026-11-10T00:59:43Z",
    "id": 5122,
    "input": null,
    "kind": "wp_admin_reset",
    "label": "Reset admin password",
    "operation_id": null,
    "output_excerpt": null,
    "queued_at": "2026-11-10T00:59:43Z",
    "requested_by": {
      "id": 2041,
      "name": "Eleanor Finch"
    },
    "result": null,
    "site": {
      "domain": "harbourandfinch.example.com",
      "id": 1042
    },
    "started_at": "2026-11-10T00:59:42Z",
    "status": "succeeded",
    "status_label": "Done"
  },
  "secret": {
    "password": "Example-new-password-1",
    "revealed_at": "2026-11-10T00:59:43+00:00",
    "url": "https://harbourandfinch.example.com/wp-admin/",
    "username": "shop-admin"
  }
}
```

### 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 id does not exist or is something you cannot see, or the feature is not on for your company (`feature_off`).

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

### 409 The reset cannot run. `reason` says why: `not_available` (the platform has no administrator to reset, such as Laravel), `managed_elsewhere`, `deleted`, `provisioning`, `not_running`, `busy` (a change is being applied to the site), `command_running` (another command is still running on it) or `exec_unresolved` (an earlier command was never confirmed stopped; contact support).

```json
{
  "code": "busy",
  "message": "A change is being applied to this site. Wait for it to finish.",
  "reason": "busy"
}
```

### 422 `username` is left out and the site has no known administrator, `username` is not one the platform takes, or `confirm` is not true.

```json
{
  "code": "invalid",
  "errors": {
    "confirm": [
      "Confirm the action"
    ]
  },
  "field": "confirm",
  "message": "Confirm the action",
  "reason": "invalid"
}
```

### 429 Too many runs: more than 20 a minute, counted together with your other platform tool runs. Wait for `Retry-After` seconds. A reset has no hourly limit of its own.

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

### 503 Corefinity has switched commands on sites off for the moment (`switched_off`). Try again later.

```json
{
  "code": "switched_off",
  "message": "Site commands are switched off at the moment",
  "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. |
| 409 | `busy` | Another operation is running on the site. Wait for it to finish. |
| 409 | `command_running` | Another action or command is still running on the site. Wait for it to finish, then try again. |
| 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 | `exec_unresolved` | An earlier command on the site has not been confirmed stopped. Contact support. |
| 409 | `managed_elsewhere` | This site is read-only here. Change it in the control panel that manages it. |
| 409 | `not_available` | The tool does not apply to this object. |
| 409 | `not_running` | The site, environment or deployment is not running. Read the message: where it can be started or will recover, start it or wait, then try again. |
| 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: [Platform tools](https://docs.corefinity.com/guides/sites/create-and-manage/platform-tools.md)
