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
| Status | Reason | What to do |
|---|---|---|
401 | none | 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. |
429 | rate_limited | Wait 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"use Illuminate\Support\Facades\Http;
$response = Http::withToken(env('COREFINITY_TOKEN'))
->acceptJson()
->get('https://manage.corefinity.com/api/corestack/sites/1042/deployments/rehearsals/77');
$data = $response->json();const res = await fetch('https://manage.corefinity.com/api/corestack/sites/1042/deployments/rehearsals/77', {
method: 'GET',
headers: {
Authorization: `Bearer ${process.env.COREFINITY_TOKEN}`,
Accept: 'application/json',
},
});
// An answer with no body (204) has nothing to parse.
const text = await res.text();
const data = text && JSON.parse(text);import os
import requests
res = requests.get(
"https://manage.corefinity.com/api/corestack/sites/1042/deployments/rehearsals/77",
headers={
"Authorization": f"Bearer {os.environ['COREFINITY_TOKEN']}",
"Accept": "application/json",
},
)
data = res.json() if res.content else None{
"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"
}
}{
"message": "Unauthenticated."
}{
"code": "company_unavailable",
"message": "Your company is unavailable.",
"reason": "company_unavailable"
}{
"code": "feature_off",
"message": "Not found.",
"reason": "feature_off"
}{
"code": "rate_limited",
"message": "Too many requests. Try again in 60 seconds.",
"reason": "rate_limited",
"retry_after_seconds": 60
}Try it
Was this helpful?