CorefinityCorefinityDocs
Open the Control PanelControl Panel
Enterprise deployments · 6 of 17

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).

GET/api/environments/{environment}/deployments/{deployment}

Path parameters

environmentintegerRequired

The id of a CoreStack Enterprise environment. Not the same number as a site row id. At least 1.

deploymentintegerRequired

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
deploymentobjectRequired

A deployment of a CoreStack Enterprise environment. Ids are strings here, except attempt_id.

Fields
artifact_pruned_atstring or nullRequired

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.

attempt_idinteger or nullRequired

The run the deployment is on now. A retry starts a new run with a new id. Null while the deployment has no run.

environment_deployment_pipeline_idstringRequired

The pipeline the deployment runs on, as the pipelines list names it.

environment_idstringRequired
errorstring or nullRequired

Why a failed deployment failed, as the last line of the step that stopped it. Null unless it failed.

git_authorobject or any or nullRequired

The commit's author, when the push gave one.

git_commitstring or nullRequired

The commit deployed. Null for an uploaded archive.

git_commit_urlstring or nullRequired

The commit's page at the git provider, when the push that started the deployment gave it.

git_merge_requestobject or any or nullRequired

The merge request or pull request of the commit, when the push gave one.

hashstring or nullRequired

The deployment's own identifier.

idstringRequired
namestring or nullRequired
notesstring or nullRequired
statusstringRequired

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.

1234567
status_descriptionstring or nullRequired

The name of the status.

ScheduledRunningFailedSucceededCancelledPendingQueuednull
retry_warningstring or nullRequired

The warning a retry would ask you to confirm with confirm_older. Null when a retry would not ask.

viewobjectRequired

What the deployment's page in the Control Panel shows you.

Fields
actionsarray of stringsRequired

The other actions you may take.

rollbackretry_from_stepcancel_scheduleddownload_log
blocked_byinteger or nullRequired

The id of the deployment this one waits behind, with queued_mode blocked. A number here.

crons_pausedobject or nullRequired

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
messagestringRequired
statestringRequired
database_failedrevert_unfinished
is_stoppingbooleanRequired
maintenance_liftobject or nullRequired

What the page says about maintenance mode a failed deployment switched on. Null when there is nothing to say.

Fields
messagestringRequired
statestringRequired
switching_offswitched_offnot_switched_off
primary_actionobjectRequired

The action the page offers first.

Fields
actionstring or nullRequired

Such as run, stop, cancel or retry. stop is the cancel endpoint here.

disabled_reasonstring or nullRequired
enabledbooleanRequired
queued_modestring or nullRequired

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_previouspauseddispatchednull
refused_actionsarray of objectsRequired

The actions the deployment calls for that your role may not take, each with the reason.

Fields of each item
actionstringRequired
disabled_reasonstringRequired
statestringRequired

The page's state.

succeededrunningfailedqueuedskippedcancelledscheduled_legacy
stop_terminationobject or nullRequired

Set when a stopped deployment's work could not be confirmed as ended. Null otherwise.

Fields
checked_atstringRequired

Format: date-time.

statestringRequired
superseded_byinteger or nullRequired

The id of the deployment that replaced this one, if any. A number here.

If it is refused

StatusReasonWhat to do
401noneSend a valid token as Authorization: Bearer <token>.
403scope_requiredUse a token with the scope named in scope.
404noneCheck the id. You see only what your account can reach.
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/environments/1311/deployments/4410 \
  -H "Authorization: Bearer $COREFINITY_TOKEN" \
  -H "Accept: application/json"
{
  "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
  }
}
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