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

Get an environment's deployment settings

Answers how the environment deploys: whether its pipeline is on, its deployment source, whether a push deploys on its own, and each of its pipelines with its folders and build switches.

GET/api/environments/{environment}/deployment-settings

Path parameters

environmentintegerRequired

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

Returns

200 The deployment settings.

Fields of the 200 answer
deployment_settingsobjectRequired
Fields
deployment_sourcestring or nullRequired

Where deployments come from.

manualsftpgitnull
deployment_sourcesarray of stringsRequired

The sources the environment may be set to. sftp is listed only for an environment that still uses it.

manualsftpgit
enterprise_env_idintegerRequired

The environment's id.

git_deploysstring or nullRequired

automatic deploys every push on its own. manual leaves each push waiting to be deployed. Null unless the pipeline is on and the source is git.

manualautomaticnull
pipeline_enabledbooleanRequired

Whether the deployment pipeline is on.

pipelinesarray of objectsRequired
Fields of each item
build_switches_editablebooleanRequired

Whether you may change the pipeline's build switches.

folders_editablebooleanRequired

Whether you may change the pipeline's folders.

isolate_build_varboolean or nullRequired

Whether a build keeps its own var folder. Null on a pipeline it does not apply to.

namestringRequired
notesarray of stringsRequired

What to know about the build switches as they are set. Empty when nothing.

pause_crons_during_buildboolean or nullRequired

Whether scheduled tasks pause while a build runs. Null on a pipeline it does not apply to.

pipeline_idintegerRequired
root_directorystringRequired

The pipeline's web folder.

root_storagestringRequired

The pipeline's storage folder.

repositoriesintegerRequired

How many repositories the environment has.

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.
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/environments/1311/deployment-settings \
  -H "Authorization: Bearer $COREFINITY_TOKEN" \
  -H "Accept: application/json"
{
  "deployment_settings": {
    "deployment_source": "git",
    "deployment_sources": [
      "manual",
      "git"
    ],
    "enterprise_env_id": 1311,
    "git_deploys": "manual",
    "pipeline_enabled": true,
    "pipelines": [
      {
        "build_switches_editable": false,
        "folders_editable": true,
        "isolate_build_var": null,
        "name": "Storefront (Wordpress)",
        "notes": [],
        "pause_crons_during_build": null,
        "pipeline_id": 2210,
        "root_directory": "/var/www/harbourandfinch.example.com/",
        "root_storage": "/var/www/harbourandfinch.example.com/shared/"
      }
    ],
    "repositories": 1
  }
}
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