CorefinityCorefinityDocs
Open the Control PanelControl Panel
Deployment pipeline · 13 of 15

Get one version of a pipeline

Answers the stages and settings as that version held them, with diff: for each stage that differs from the current pipeline, or from the version named in compare_to, its lines before and after, and under settings each setting that differs. diff is null when nothing differs. A version kept of a pipeline that did not have the three stages yet answers stages and settings null.

GET/api/corestack/sites/{site}/deployments/pipeline/{binding}/versions/{version}

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.

bindingintegerRequired

The id of one of the environment's pipelines, as the pipeline read answers it in binding_id and bindings[].id. Digits only. At least 1.

versionintegerRequired

The version_id of one of the pipeline's versions. Digits only. At least 1.

Query parameters

compare_tostring or integer

Another version_id to compare with, or current for the current pipeline, which is the default.

Returns

200 The version.

Fields of the 200 answer
atstringRequired
bystring or null

The name of the person who saved it.

changedarray of stringsRequired

The stages this version changed, and settings.

numberintegerRequired

The version's number in this pipeline, counting from 1.

restorablebooleanRequired
restorable_reasonstring or null

Why not, when it cannot be restored.

sourcestring

How the version was made, such as editor, restore or template.

templateobject

For a version a deployment template wrote, the template (template_id) and its revision (template_revision).

version_idintegerRequired
compare_tostringRequired

current, or the version_id compared with.

diffobject or nullRequired

By stage that differs, its lines before (this version) and after (what it is compared with), and under settings, by setting that differs, its value before and after. Null when nothing differs.

settingsobject or any or nullRequired

The settings as the version held them. Null for a version kept of a pipeline that did not have the three stages yet.

stagesobject or any or nullRequired

The stages as the version held them. Null for a version kept of a pipeline that did not have the three stages yet.

If it is refused

StatusReasonWhat to do
401noneSend a valid token as Authorization: Bearer <token>.
403company_unavailableYour company is unavailable.
403scope_requiredUse a token with the scope named in scope.
403two_factor_requiredTurn on two-factor on your account, then send again.
404feature_offThis feature is not on for your organisation yet.
422invalidFix the field named in field; errors says why.
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/corestack/sites/1042/deployments/pipeline/2210/versions/5001 \
  -H "Authorization: Bearer $COREFINITY_TOKEN" \
  -H "Accept: application/json"
{
  "at": "2026-11-09T10:42:07Z",
  "by": "Maya Okafor",
  "changed": [
    "settings"
  ],
  "compare_to": "current",
  "diff": null,
  "number": 2,
  "restorable": false,
  "restorable_reason": "This is the current version.",
  "settings": {
    "keep_node_modules": false,
    "maintenance_policy": "off",
    "pause_crons": "auto",
    "run_migrations": null,
    "timeouts": {
      "build": 3600,
      "build_line": 3600,
      "database_line": 600,
      "post_line": 600
    },
    "tunnels": "off"
  },
  "source": "editor",
  "stages": {
    "build": {
      "effective": [],
      "hooks": [],
      "lines": [],
      "mode": "preset",
      "preset": {
        "frontend": [],
        "options": [],
        "platform": "none"
      }
    },
    "database": {
      "lines": [],
      "platform_step_at": 0
    },
    "post_deploy": {
      "lines": [
        {
          "badges": [],
          "comments": [],
          "origin": "custom",
          "text": "php artisan queue:restart",
          "verdict": "services"
        },
        {
          "badges": [
            {
              "id": "replaced_by_platform",
              "label": "Replaced by a CoreStack step",
              "severity": "info"
            }
          ],
          "comments": [],
          "origin": "custom",
          "text": "php artisan config:cache",
          "verdict": "platform_duplicate"
        }
      ]
    }
  },
  "version_id": 5002
}
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