Get a deployment
Answers one deployment of the environment, with view (what its page in the Control Panel shows you) and retry_warning. Read it again to follow a deployment until status is 3 (Failed), 4 (Succeeded) or 5 (Cancelled).
Path parameters
The id of a CoreStack Enterprise environment. Not the same number as a site row id. At least 1.
The id of a deployment of the environment. A deployment of another environment is not found. At least 1.
Returns
200 The deployment, its view and its retry warning.
Fields of the 200 answer
A deployment of a CoreStack Enterprise environment. Ids are strings here, except attempt_id.
Fields
When the deployment's release archive was removed. A deployment with one cannot be retried or rolled back to. Null while the archive is kept.
The run the deployment is on now. A retry starts a new run with a new id. Null while the deployment has no run.
The pipeline the deployment runs on, as the pipelines list names it.
Why a failed deployment failed, as the last line of the step that stopped it. Null unless it failed.
The commit's author, when the push gave one.
The commit deployed. Null for an uploaded archive.
The commit's page at the git provider, when the push that started the deployment gave it.
The merge request or pull request of the commit, when the push gave one.
The deployment's own identifier.
The status as a number in a string: 1 Scheduled, 2 Running, 3 Failed, 4 Succeeded, 5 Cancelled, 6 Pending (waiting to be deployed by hand), 7 Queued.
1234567The name of the status.
ScheduledRunningFailedSucceededCancelledPendingQueuednullThe warning a retry would ask you to confirm with confirm_older. Null when a retry would not ask.
What the deployment's page in the Control Panel shows you.
Fields
The other actions you may take.
rollbackretry_from_stepcancel_scheduleddownload_logThe id of the deployment this one waits behind, with queued_mode blocked. A number here.
What the page says when scheduled tasks and queues stay paused after a failed or stopped deployment. Null when there is nothing to say.
Fields
database_failedrevert_unfinishedWhat the page says about maintenance mode a failed deployment switched on. Null when there is nothing to say.
Fields
switching_offswitched_offnot_switched_offThe action the page offers first.
Fields
Such as run, stop, cancel or retry. stop is the cancel endpoint here.
Why a queued deployment waits: manual (for a person to deploy it), blocked (behind another deployment), awaiting_previous (behind its own earlier attempt), paused (deployments are paused for the moment) or dispatched (it is about to start). Null when it is not queued.
manualblockedawaiting_previouspauseddispatchednullThe actions the deployment calls for that your role may not take, each with the reason.
Fields of each item
The page's state.
succeededrunningfailedqueuedskippedcancelledscheduled_legacySet when a stopped deployment's work could not be confirmed as ended. Null otherwise.
Fields
Format: date-time.
The id of the deployment that replaced this one, if any. A number here.
If it is refused
| Status | Reason | What to do |
|---|---|---|
401 | none | Send a valid token as Authorization: Bearer <token>. |
403 | scope_required | Use a token with the scope named in scope. |
404 | none | Check the id. You see only what your account can reach. |
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/environments/1311/deployments/4410 \
-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/environments/1311/deployments/4410');
$data = $response->json();const res = await fetch('https://manage.corefinity.com/api/environments/1311/deployments/4410', {
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/environments/1311/deployments/4410",
headers={
"Authorization": f"Bearer {os.environ['COREFINITY_TOKEN']}",
"Accept": "application/json",
},
)
data = res.json() if res.content else None{
"deployment": {
"artifact_pruned_at": null,
"attempt_id": 190419,
"environment_deployment_pipeline_id": "2210",
"environment_id": "1311",
"error": null,
"git_author": null,
"git_commit": "5c1d0e9a7b3f42d68a0c9e1f7b2d4a6c8e0f1a3b",
"git_commit_url": null,
"git_merge_request": null,
"hash": "71a7eaca-89a7-4a5f-a7af-17d38ca685e6",
"id": "4410",
"name": "Release 2026.10.4",
"notes": null,
"status": "3",
"status_description": "Failed"
},
"retry_warning": null,
"view": {
"actions": [
"download_log"
],
"blocked_by": null,
"crons_paused": null,
"is_stopping": false,
"maintenance_lift": null,
"primary_action": {
"action": "retry",
"disabled_reason": null,
"enabled": true
},
"queued_mode": null,
"refused_actions": [],
"state": "failed",
"stop_termination": null,
"superseded_by": null
}
}{
"message": "Unauthenticated."
}{
"code": "scope_required",
"message": "This access token does not have the destructive scope this needs. Use a token with the destructive scope.",
"reason": "scope_required",
"scope": "destructive"
}{
"message": "Not found."
}{
"code": "rate_limited",
"message": "Too many requests. Try again in 60 seconds.",
"reason": "rate_limited",
"retry_after_seconds": 60
}