CorefinityCorefinityDocs
Open the Control PanelControl Panel
Deployments · 17 of 65

corestack_deployments_options_update

Update deployment options.

Scope writeNo secrets returned
On this page

When to use it

Change the environment's deployment options, which every binding of it uses: extra shared paths, the paths a build reads, a snapshot before an upgrade (Magento 2 only), the pre-switch check, the warm-up after the switch, the Cloudflare purge and, on Magento 2, the Varnish purge right after the switch (on by default). Only the options you send change; send a list whole. An extra shared path's location under shared/ is kept as stored (it is set in the Control Panel). Read them back with corestack_deployments_pipeline_get (its options, with the platform's own shared paths an extra one must not overlap).

The same action in the public REST API, with the same checks, refusals and scope: PUT /api/corestack/sites/{site}/deployments/options.

Ask for it

Prompt
Using the Corefinity MCP server, call corestack_deployments_options_update with site_id 4211, warm_up {"enabled":true,"paths":["/","/shop"]}, cloudflare_purge true. (Update deployment options.) Tell me what it returned.

Inputs

build_readsarray of strings

The whole list of paths relative to the site root. Up to 10 items.

cloudflare_purgeboolean
extra_shared_pathsarray of strings or objects

The whole list: paths relative to the site root, each {path, kind dir|file} or a folder's path. A path keeps its stored location under shared/. Up to 50 items.

Fields of an item given as an object
kindstring
dirfile
pathstringRequired

Up to 255 characters.

pre_switch_checkboolean or object

Off, on, or {enabled, paths[]} of up to five paths starting with a slash.

site_idintegerRequired

At least 1.

snapshot_before_upgradeboolean

Magento 2 only.

varnish_purgeboolean

Magento 2 only: purge Varnish right after the release switch (on unless set to false).

warm_upboolean or object

Off, on, or {enabled, paths[]} of up to ten paths starting with a slash.

Example call

tools/call
{
  "name": "corestack_deployments_options_update",
  "arguments": {
    "site_id": 4211,
    "warm_up": {
      "enabled": true,
      "paths": [
        "/",
        "/shop"
      ]
    },
    "cloudflare_purge": true
  }
}

If it is refused

ReasonWhat to do
forbiddenThe person's role lacks the Edit Environment Deployment Pipeline permission. The message names it and says an owner of the company can grant it in Roles; details.permission is editEnvironmentDeploymentPipeline. Nothing is changed.
wrong_platformA snapshot before an upgrade, and the Varnish purge, are for Magento 2 sites only.
managed_elsewhereAnother control panel manages this site, so use that control panel for it. This is refused before anything else about the site, as in the Control Panel and the API. Nothing was done.
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