CorefinityCorefinityDocs
Open the Control PanelControl Panel
Deployment pipeline · 15 of 15

Get a rehearsal

Answers a rehearsal and how far it has got. Read it until state is no longer running.

GET/api/corestack/sites/{site}/deployments/rehearsals/{rehearsal}

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.

rehearsalintegerRequired

The id of a rehearsal of this environment. Digits only. At least 1.

Returns

200 The rehearsal.

Fields of the 200 answer
rehearsalobjectRequired
Fields
binding_idinteger

The pipeline of this environment the rehearsal runs on.

failed_lineobject

Present when one line failed. Its stage, index and text.

failureobject

Present on a rehearsal that failed. What went wrong, with its message.

finished_atstring or null
idintegerRequired
per_stageobject

Each part of the rehearsal with where it is, such as pending or skipped.

skippedarray

What the rehearsal leaves out, each with why.

started_atstring or null
statestringRequired

running until the rehearsal has finished, then how it ended, such as passed.

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.
429rate_limitedWait for the seconds in Retry-After.

Reasons are listed by name in Errors and refusals.

The same task elsewhere

curl https://manage.corefinity.com/api/corestack/sites/1042/deployments/rehearsals/77 \
  -H "Authorization: Bearer $COREFINITY_TOKEN" \
  -H "Accept: application/json"
{
  "rehearsal": {
    "binding_id": 2211,
    "finished_at": null,
    "id": 77,
    "per_stage": {
      "build": "skipped",
      "database": "skipped",
      "platform_step": "pending",
      "shared_files": "pending",
      "upload": "pending"
    },
    "skipped": [],
    "started_at": "2026-11-09T10:42:07Z",
    "state": "running"
  }
}
Try it
Held in this tab's memory only. Never stored or sent to us.

Use a token with only the read scope. How to make one

Was this helpful?
Open in ClaudeOpen in ChatGPT