Create an environment's repository
Connects a git repository to the environment through one of the git accounts GET / lists. Your role needs the Manage Deployment Repositories permission and, while a push deploys on its own (git_deploys is automatic), Create Deployments as well.
Path parameters
The id of a CoreStack Enterprise environment. Not the same number as a site row id. At least 1.
Body
The branch to deploy. No spaces, no .., and no - at the start. Up to 255 characters.
The id of a git account GET / lists. The repository's provider is the account's.
The id of the environment's pipeline the repository deploys with. A missing or wrong value is reported on environment_deployment_pipeline_id.
The repository's path at the provider, such as northwind-digital/: 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.
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
201 The repository, as the list shows it.
Fields of the 201 answer
A git repository an environment deploys from.
Fields
The branch deployed. Null when connection_hidden is true.
True when the repository was set up with a git account you cannot use. You cannot change such a repository.
The agency that set the repository up, when it is hidden and you belong to the company that agency manages. Null otherwise.
The pipeline the repository deploys with.
The git provider, such as github. Null when connection_hidden is true.
The repository's path at the provider. Null when connection_hidden is true.
If it is refused
| Status | Reason | What to do |
|---|---|---|
401 | none | Send a valid token as Authorization: Bearer <token>. |
403 | company_unavailable | Your company is unavailable. |
403 | forbidden | The person is not allowed to do this. |
403 | scope_required | Use a token with the scope named in scope. |
403 | two_factor_required | Turn on two-factor on your account, then send again. |
404 | none | Check the id. You see only what your account can reach. |
422 | invalid | Fix the field named in field; errors says why. |
429 | rate_limited | Wait for the seconds in Retry-After. |
Reasons are listed by name in Errors and refusals.
The same task elsewhere
curl -X POST https://manage.corefinity.com/api/environments/1311/repositories \
-H "Authorization: Bearer $COREFINITY_TOKEN" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-d '{
"branch": "main",
"connection_id": 4216,
"pipeline_id": 2210,
"repo": "northwind-digital/harbourandfinch-trade-theme",
"root_directory": "/"
}'use Illuminate\Support\Facades\Http;
$response = Http::withToken(env('COREFINITY_TOKEN'))
->acceptJson()
->post('https://manage.corefinity.com/api/environments/1311/repositories', [
'branch' => 'main',
'connection_id' => 4216,
'pipeline_id' => 2210,
'repo' => 'northwind-digital/harbourandfinch-trade-theme',
'root_directory' => '/',
]);
$data = $response->json();const res = await fetch('https://manage.corefinity.com/api/environments/1311/repositories', {
method: 'POST',
headers: {
Authorization: `Bearer ${process.env.COREFINITY_TOKEN}`,
Accept: 'application/json',
'Content-Type': 'application/json',
},
body: JSON.stringify({
branch: 'main',
connection_id: 4216,
pipeline_id: 2210,
repo: 'northwind-digital/harbourandfinch-trade-theme',
root_directory: '/',
}),
});
// An answer with no body (204) has nothing to parse.
const text = await res.text();
const data = text && JSON.parse(text);import os
import requests
res = requests.post(
"https://manage.corefinity.com/api/environments/1311/repositories",
headers={
"Authorization": f"Bearer {os.environ['COREFINITY_TOKEN']}",
"Accept": "application/json",
},
json={
"branch": "main",
"connection_id": 4216,
"pipeline_id": 2210,
"repo": "northwind-digital/harbourandfinch-trade-theme",
"root_directory": "/",
},
)
data = res.json() if res.content else None{
"environment_repository": {
"branch": "main",
"connection_hidden": false,
"connection_owner": null,
"environment_deployment_pipeline_id": "2210",
"id": "3302",
"provider": "github",
"repo": "northwind-digital/harbourandfinch-trade-theme"
}
}{
"message": "Unauthenticated."
}{
"code": "company_unavailable",
"message": "Your company is unavailable.",
"reason": "company_unavailable"
}{
"message": "Not found."
}{
"code": "invalid",
"errors": {
"connection_id": [
"The selected git account could not be found."
]
},
"field": "connection_id",
"message": "The selected git account could not be found.",
"reason": "invalid"
}{
"code": "rate_limited",
"message": "Too many requests. Try again in 60 seconds.",
"reason": "rate_limited",
"retry_after_seconds": 60
}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.