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

Update an environment's repository

Replaces the repository's git account, pipeline, repository path, branch and folder. Send every field, as when adding one. The permissions are those of adding a repository.

PATCH/api/environments/{environment}/repositories/{repository}

Path parameters

environmentintegerRequired

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

repositoryintegerRequired

The id of a repository of the environment, as GET /environments/{environment}/repositories lists it. Digits only. At least 1.

Body

branchstringRequired

The branch to deploy. No spaces, no .., and no - at the start. Up to 255 characters.

connection_idintegerRequired

The id of a git account GET /environments/{environment}/repositories/connections lists. The repository's provider is the account's.

pipeline_idintegerRequired

The id of the environment's pipeline the repository deploys with. A missing or wrong value is reported on environment_deployment_pipeline_id.

repostringRequired

The repository's path at the provider, such as northwind-digital/harbourandfinch-trade: parts of letters, digits, ., _ and - separated by /, none of them . or .., at most 255 characters. Exactly owner/name for a GitHub or Bitbucket account; two or more parts for a GitLab account.

root_directorystringRequired

The folder of the repository that is deployed, such as /web or apps/site; / for the whole repository. Letters, digits, _, ., - and / only, with no .. part, at most 255 characters.

Returns

200 The repository as it is now.

Fields of the 200 answer
environment_repositoryobjectRequired

A git repository an environment deploys from.

Fields
branchstring or nullRequired

The branch deployed. Null when connection_hidden is true.

connection_hiddenbooleanRequired

True when the repository was set up with a git account you cannot use. You cannot change such a repository.

connection_ownerstring or nullRequired

The agency that set the repository up, when it is hidden and you belong to the company that agency manages. Null otherwise.

environment_deployment_pipeline_idstring or nullRequired

The pipeline the repository deploys with.

idstringRequired
providerstring or nullRequired

The git provider, such as github. Null when connection_hidden is true.

repostring or nullRequired

The repository's path at the provider. Null when connection_hidden is true.

If it is refused

StatusReasonWhat to do
401noneSend a valid token as Authorization: Bearer <token>.
403company_unavailableYour company is unavailable.
403forbiddenThe person is not allowed to do this.
403scope_requiredUse a token with the scope named in scope.
403two_factor_requiredTurn on two-factor on your account, then send again.
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 -X PATCH https://manage.corefinity.com/api/environments/1311/repositories/3301 \
  -H "Authorization: Bearer $COREFINITY_TOKEN" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{
    "branch": "release",
    "connection_id": 4216,
    "pipeline_id": 2210,
    "repo": "northwind-digital/harbourandfinch-trade",
    "root_directory": "/"
  }'
{
  "environment_repository": {
    "branch": "release",
    "connection_hidden": false,
    "connection_owner": null,
    "environment_deployment_pipeline_id": "2210",
    "id": "3301",
    "provider": "github",
    "repo": "northwind-digital/harbourandfinch-trade"
  }
}
Try it

Try it is off for this endpointIt has not been cleared for the console. Copy the request and run it yourself when you are sure.

Was this helpful?
Open in ClaudeOpen in ChatGPT