---
title: "Start a platform tool"
url: https://docs.corefinity.com/api/reference/sites/start-site-function
type: endpoint
last_updated: 2026-11-13
feature: functions
related:
  - https://docs.corefinity.com/guides/sites/create-and-manage/platform-tools.md
  - https://docs.corefinity.com/mcp/tools/corestack_function_run.md
---
# Start a platform tool

Runs one of the site's tools with its inputs in the body, and `"confirm": true` where the tool asks for it.
A run that has finished answers `200`; one that is queued or running answers `202`, to follow with the command endpoint.

```http
POST /api/corestack/sites/{site}/functions/{function}
```

- Scope: `exec`
- 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 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.
- `function` (string, required): The `key` of a tool from the site's list. Lower-case letters, digits and `_`.

## Body

- `confirm` (boolean): True, for a tool that asks for confirmation.

## Request

### curl

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

### PHP

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

$response = Http::withToken(env('COREFINITY_TOKEN'))
    ->acceptJson()
    ->post('https://manage.corefinity.com/api/corestack/sites/1042/functions/flush_cache', (object) []);

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

### Node

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

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

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

## Responses

### 200 The run has finished. A tool that creates a password answers it once in `secret`, with `Cache-Control: no-store`.

```json
{
  "command": {
    "blocked_until_verified": false,
    "duration_ms": 840,
    "error": null,
    "exit_code": 0,
    "finished_at": "2026-11-19T09:30:01Z",
    "id": 5120,
    "input": null,
    "kind": "flush_cache",
    "label": "Flush cache",
    "operation_id": null,
    "output_excerpt": "Success: The cache was flushed.\n",
    "queued_at": "2026-11-19T09:30:00Z",
    "requested_by": {
      "id": 2012,
      "name": "Daniel Reyes"
    },
    "result": {
      "flushed": true
    },
    "site": {
      "domain": "journal.harbourandfinch.example.com",
      "id": 1051
    },
    "started_at": "2026-11-19T09:30:00Z",
    "status": "succeeded",
    "status_label": "Done"
  }
}
```

### 202 The run is queued or running. Follow `command.id`.

```json
{
  "command": {
    "blocked_until_verified": false,
    "duration_ms": null,
    "error": null,
    "exit_code": null,
    "finished_at": null,
    "id": 5120,
    "input": null,
    "kind": "flush_cache",
    "label": "Flush cache",
    "operation_id": null,
    "output_excerpt": null,
    "queued_at": "2026-11-19T09:30:00Z",
    "requested_by": {
      "id": 2012,
      "name": "Daniel Reyes"
    },
    "result": null,
    "site": {
      "domain": "journal.harbourandfinch.example.com",
      "id": 1051
    },
    "started_at": null,
    "status": "queued",
    "status_label": "Queued"
  }
}
```

### 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 site cannot run this now, and nothing was run. `reason` says why. The site's state: `deleted`, `provisioning`, `removed`, `wrong_platform` (the tool is not one of this site's platform), `not_running`, `managed_elsewhere`, or `site_unadopted` (the site cannot be changed from the Control Panel yet; contact support). Something else is running, so wait for it and try again: `busy` (another change), `command_running` (another tool or command), `deployment_running`, `restore_running`, or, for a tool that stops the site's processes, `snapshot_running`. A command whose end was never confirmed: `exec_unresolved` and `install_running`. Waiting does not clear these; contact support.

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

### 422 The tool does not exist, an input is missing or wrong, or the tool asks for `"confirm": 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, or the hourly limit of this tool on this site. Wait for `Retry-After` seconds.

```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 | `deployment_running` | A deployment of the environment is running, or a stopped one is still being cleaned up. Wait for it to finish, then try again. |
| 409 | `exec_unresolved` | An earlier command on the site has not been confirmed stopped. Contact support. |
| 409 | `install_running` | An installer is still running on the site. Contact support. |
| 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. |
| 409 | `removed` | The site or environment is being removed, or has been. Nothing can be changed on it. |
| 409 | `restore_running` | A restore is running on the site. Wait for it to finish, then try again. |
| 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)
- MCP tool: [`corestack_function_run`](https://docs.corefinity.com/mcp/tools/corestack_function_run.md)
