CorefinityCorefinityDocs
Open the Control PanelControl Panel
Platform tools · 4 of 4

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.

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

Path parameters

siteintegerRequired

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.

functionstringRequired

The key of a tool from the site's list. Lower-case letters, digits and _.

Body

confirmboolean

True, for a tool that asks for confirmation.

Returns

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

202 The run is queued or running. Follow command.id. Poll the operation until it finishes.

Fields of the 200 answer
commandobjectRequired

One run of a platform tool or another command on a site.

Fields
blocked_until_verifiedboolean
duration_msinteger or null
errorstring or nullRequired
exit_codeinteger or null
finished_atstring or nullRequired

Format: date-time.

idintegerRequired

At least 1.

inputany

The inputs the run was given. Never a secret.

kindstringRequired

The key of what ran, such as flush_cache.

labelstringRequired
operation_idinteger or null
output_excerptstring or null
queued_atstring or nullRequired

Format: date-time.

requested_byobject or any or null
resultanyRequired

What the run answered, by tool.

siteobjectRequired

A site by its id and domain.

Fields
domainstringRequired
idintegerRequired
started_atstring or nullRequired

Format: date-time.

statusstringRequired

succeeded, failed, timed_out and lost are final.

queuedrunningsucceededfailedtimed_outlost
status_labelstringRequired
secretany

A password the tool created, answered once and never stored. Sent only by tools that create one.

Fields of the 202 answer
commandobjectRequired

One run of a platform tool or another command on a site.

Fields
blocked_until_verifiedboolean
duration_msinteger or null
errorstring or nullRequired
exit_codeinteger or null
finished_atstring or nullRequired

Format: date-time.

idintegerRequired

At least 1.

inputany

The inputs the run was given. Never a secret.

kindstringRequired

The key of what ran, such as flush_cache.

labelstringRequired
operation_idinteger or null
output_excerptstring or null
queued_atstring or nullRequired

Format: date-time.

requested_byobject or any or null
resultanyRequired

What the run answered, by tool.

siteobjectRequired

A site by its id and domain.

Fields
domainstringRequired
idintegerRequired
started_atstring or nullRequired

Format: date-time.

statusstringRequired

succeeded, failed, timed_out and lost are final.

queuedrunningsucceededfailedtimed_outlost
status_labelstringRequired
secretany

A password the tool created, answered once and never stored. Sent only by tools that create one.

If it is refused

StatusReasonWhat to do
401noneSend a valid token as Authorization: Bearer <token>.
403company_unavailableYour company is unavailable.
403scope_requiredUse a token with the scope named in scope.
403two_factor_requiredTurn on two-factor on your account, then send again.
404feature_offThis feature is not on for your organisation yet.
409busyAnother operation is running on the site. Wait for it to finish.
409command_runningAnother action or command is still running on the site. Wait for it to finish, then try again.
409deletedThe 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.
409deployment_runningA deployment of the environment is running, or a stopped one is still being cleaned up. Wait for it to finish, then try again.
409exec_unresolvedAn earlier command on the site has not been confirmed stopped. Contact support.
409install_runningAn installer is still running on the site. Contact support.
409not_runningThe 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.
409provisioningThe site is still being created. Try again in a few minutes.
409removedThe site or environment is being removed, or has been. Nothing can be changed on it.
409restore_runningA restore is running on the site. Wait for it to finish, then try again.
422invalidFix the field named in field; errors says why.
429rate_limitedWait for the seconds in Retry-After.
503switched_offCorefinity 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/functions/flush_cache \
  -H "Authorization: Bearer $COREFINITY_TOKEN" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{}'
{
  "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"
  }
}
Try it

Try it is off for this endpointIt runs commands on a live site. Copy the request and run it yourself when you are sure.

Was this helpful?
Open in ClaudeOpen in ChatGPT