CorefinityCorefinityDocs
Open the Control PanelControl Panel
Deployments · 51 of 65

corestack_enterprise_deployment_get

A CoreStack Enterprise deployment.

Scope readNo secrets returned
On this page

When to use it

Read one deployment of a CoreStack Enterprise environment as its page shows it to the person: its state, the button the page offers first, the rest of its menu, and the warning Retry would ask with. It is the status tool of the tasks that corestack_enterprise_deployment_trigger, _retry and _rollback start. It never answers task output or commands, beyond error: why a failed deployment failed, the last line of the step that failed (null unless it failed).

The public API's GET /api/environments/{environment}/deployments/{deployment} answers the same view, retry_warning and error beside the deployment.

The answer's deployment is the list's row (with error and the commit's git_commit_url, git_author and git_merge_request) plus notes, retry_warning (null unless Retry would ask first) and view:

  • state: what the page says is happening (for example queued, running, succeeded, failed, cancelled, skipped)
  • queued_mode, blocked_by (the deployment it waits for), superseded_by, is_stopping
  • primary_action {action, enabled, disabled_reason}: run is corestack_enterprise_deployment_trigger with deployment_id; stop and cancel are corestack_enterprise_deployment_cancel; retry is corestack_enterprise_deployment_retry
  • actions: the menu entries the page offers this person: rollback (corestack_enterprise_deployment_rollback), retry_from_step (corestack_enterprise_deployment_retry with from: failed_step: carry on from the step that failed), cancel_scheduled, download_log
  • refused_actions [{action, disabled_reason}]: the menu entries the deployment's state calls for but this person's role may not use (rollback, retry_from_step, cancel_scheduled). The page shows them disabled, and disabled_reason names the permission they need and who can grant it, in the words the tool would refuse with. Empty when nothing is held back.
  • maintenance_lift: null, or for a failed deployment that switched maintenance mode on and failed before switching it off, {state, message}: switching_off (it is being switched off automatically), switched_off, or not_switched_off (Corefinity has been alerted). message is the sentence the page shows. Only the deployment that switched it on ever switches it off this way.
  • crons_paused: null, or for a failed or stopped deployment whose crons and queues stay paused, {state, message}: database_failed (a database command failed: they stay paused until a Stop or Retry reverts the deployment) or revert_unfinished (a Stop or Retry did not finish reverting it: on a failed deployment Retry runs it again; on a stopped one Corefinity releases them). message is the sentence the page shows. Null while a Stop or Retry is still reverting it.
  • stop_termination: null, or for a stopped deployment whose running step could not be confirmed ended within the time allowed (where Stop termination is enabled for the environment), {state: not_terminated, checked_at}. The step may still be doing work on the servers it used, and staff have been alerted; the page shows the same sentence. Absent for a stop that ended cleanly.

When a new release's container keeps exiting, the deployment fails as soon as that is clear rather than waiting for its timeout, and error says so: Application failure: the new release's container "php" in application keeps exiting (exit code 127, Error; 4 times). Last message: …. Fix what the container runs and deploy again.

Ask for it

Prompt
Using the Corefinity MCP server, call corestack_enterprise_deployment_get with enterprise_env_id 1530, deployment_id 185172. (A CoreStack Enterprise deployment.) Tell me what it returned.

Inputs

deployment_idintegerRequired

A deployment of that environment At least 1.

enterprise_env_idintegerRequired

A CoreStack Enterprise environment's id; for CoreStack or CoreCluster use the corestack_deployment_* tools. At least 1.

Example call

tools/call
{
  "name": "corestack_enterprise_deployment_get",
  "arguments": {
    "enterprise_env_id": 1530,
    "deployment_id": 185172
  }
}

If it is refused

ReasonWhat to do
invalid_argumentsA CoreStack or CoreCluster environment; use its site_id tools.
tenant_mismatchNo such environment or deployment is yours, or the deployment belongs to another environment.
pin_refusedA token limited to some sites cannot reach a CoreStack Enterprise environment.
scope_requiredThe token lacks a scope this call needs. Open the link in the answer to add it, then call again.
rate_limitedToo many calls. Wait for the number of seconds the answer names.
temporarily_unavailableThe Control Panel could not answer just now. Nothing was started; try again shortly.
internal_errorSomething went wrong on our side. Quote the trace id to support.

The same task elsewhere

Was this helpful?
Open in ClaudeOpen in ChatGPT