CorefinityCorefinityDocs
Open the Control PanelControl Panel
Deployments · 10 of 65

corestack_deployments_pipeline_get

Deployment pipeline.

Scope readNo secrets returned
On this page

When to use it

Read a deployment pipeline before changing it: its build, database and post-deploy stages (every line redacted, with its check verdict and badges), its settings, placement, the presets on offer, the environment's deployment options and the revision every change must send. Pass binding_id for another binding of the environment. With version_id (from corestack_deployments_pipeline_versions_list) it reads that saved version instead, with what differs per stage and setting from compare_to: the current pipeline, or another version. Never a variable value or a secret.

A pipeline comes in one of two layouts, named by stage_model:

  • three_stage: stages holds the build, database and post-deploy lines you can change, and classic is null.
  • a classic pipeline (stage_model null): stages and settings are null and changes are refused with pipeline_classic. classic lists what it actually runs: each block in the order the deployment runs it (on a version 3 site first build_server, the platform's build commands run as one Building step on the build server; then build; on a version 2 Kubernetes environment database, between maintenance_on and maintenance_off when maintenance mode brackets it; then post_build), each line under the name its step has on the deployment page (Build command 2), with source custom for the environment's own lines, shared for the platform's shared pipeline it inherits, or platform for the build server block. Credentials are redacted; a comment line is listed with the line it precedes. runs is false when the pipeline is refused at deploy and runs nothing.

On a version 2 environment a classic pipeline's build lines run while the live site keeps serving visitors, against its database. Database changes that need maintenance mode belong in the database commands, with maintenance mode switched on (the database block between maintenance_on and maintenance_off). The shared Magento 2 pipeline switches maintenance mode on in its build for the setup:upgrade line alone.

A classic pipeline's answer includes:

JSON
{
  "stage_model": null,
  "stages": null,
  "classic": {
    "pipeline_version": 3,
    "runs": true,
    "sections": [
      {"key": "build", "label": "Build command", "source": "shared", "lines": [
        {"label": "Build command 1", "command": "composer install --no-interaction --no-dev --optimize-autoloader", "comments": []}
      ]},
      {"key": "post_build", "label": "Post build command", "source": "custom", "lines": [
        {"label": "Post build command 1", "command": "php artisan migrate --force", "comments": ["# schema first"]}
      ]}
    ]
  }
}

The same action in the public REST API, with the same checks, refusals and scope: GET /api/corestack/sites/{site}/deployments/pipeline (binding_id), and with version_id GET /api/corestack/sites/{site}/deployments/pipeline/{binding}/versions/{version} (compare_to).

Ask for it

Prompt
Using the Corefinity MCP server, call corestack_deployments_pipeline_get with site_id 4211, version_id 381, compare_to current. (Deployment pipeline.) Tell me what it returned.

Inputs

binding_idinteger

Default: the environment's default binding. At least 1.

compare_tostring or integer

With version_id: current (the default) or another version_id.

site_idintegerRequired

At least 1.

version_idinteger

A version from corestack_deployments_pipeline_versions_list: read it instead of the current pipeline. At least 1.

Example call

tools/call
{
  "name": "corestack_deployments_pipeline_get",
  "arguments": {
    "site_id": 4211,
    "version_id": 381,
    "compare_to": "current"
  }
}

If it is refused

ReasonWhat to do
invalid_argumentsThe arguments do not match the tool's input schema, or the Control Panel refused a field. Fix the fields named in the answer and call again.
tenant_mismatchThe object does not exist or the token may not see it. Check the id.
scope_requiredThe token lacks a scope this call needs. Open the link in the answer to add it, then call again.
pin_refusedThe grant is limited to chosen clusters, sites or environments, and this call is outside them. Open the link in the answer to widen it.
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