environments

Update environment

Partially update an environment; omitted fields stay unchanged.

Renaming also changes the slug and returns 400 if another environment already uses it.

Required permission: environments.update.

patch/v1/projects/{project_id}/environments/{environment_id}

Request

  • Base URL: https://api.connic.co
  • URL: https://api.connic.co/v1/projects/{project_id}/environments/{environment_id}
  • Auth: HTTP bearer

Path parameters

project_idstring uuid required

ID of the project the API key belongs to.

environment_idstring uuid required

Environment ID from GET /environments.

Request body

log_retention_secondsinteger nullable

How long runs are kept before automatic deletion, in seconds. At most the plan's retention; null uses the plan's retention.

redacted_keysstring[]

JSON field paths, such as user.token or *.password, whose values are replaced with [REDACTED] in newly recorded run data, logs and traces. Case-sensitive; an empty list disables redaction.

manual_deploy_group_idsstring[] nullable

Permission group IDs whose members can start deployments manually in this environment. null allows all groups; an empty list allows only the project owner.

copy_from_group_idsstring[] nullable

Permission group IDs whose members can copy data from this environment into another. null allows all groups; an empty list allows only the project owner.

namestring nullable

Display name. Its slug must be unique among the project's environments.

git_branchstring nullable

Git branch whose pushes deploy to this environment.

is_activeboolean nullable

When false, pushes and pull requests on git_branch no longer trigger deployments or PR tests.

test_environment_idstring uuid nullable

Another environment in the project whose variables, connectors and credentials the deploy gate tests use. null runs tests in this environment.

pr_testing_enabledboolean nullable

Run the test suite when a pull request targets git_branch. Pro and Enterprise plans only.

deploy_gate_tests_enabledboolean nullable

Run the test suite before each deployment in this environment is activated.

Response

Successful Response

idstring uuid required
project_idstring uuid required

Project the environment belongs to.

namestring required
slugstring required

URL-safe identifier derived from name, unique within the project.

git_branchstring nullable required

Git branch this environment deploys from. Null when deployments come from CLI uploads.

is_activeboolean required

Whether the environment is active. Git pushes and pull request tests only target active environments.

is_defaultboolean required

Whether this is the project's default environment. A project has exactly one.

env_typestring required

standard for regular environments, test for dev environments created by connic dev.

is_ephemeralboolean required

True for dev environments that are deleted when their connic dev session ends.

test_environment_idstring uuid nullable required

Environment the test suite runs in for deploy gate and pull request tests. Null runs the tests in this environment.

pr_testing_enabledboolean required

Whether the test suite runs for pull requests that target git_branch.

deploy_gate_tests_enabledboolean required

Whether deployments run the test suite before activating. A failing case stops the deployment.

log_retention_secondsinteger nullable required

How long run data is kept, in seconds. Null applies the plan's default retention.

log_retention_max_secondsinteger nullable required

Longest retention the project's plan allows, in seconds. Null means no limit.

redacted_keysstring[] required

Dot-separated JSON paths whose values are replaced with [REDACTED] in stored run data, traces and connector logs. A leading * matches at any depth, as in *.password.

manual_deploy_group_idsstring[] nullable required

Permission groups whose members can deploy to this environment manually. Null allows everyone with deploy permission; an empty list allows only the project owner.

copy_from_group_idsstring[] nullable required

Permission groups whose members can copy from this environment into other environments. Null allows everyone; an empty list allows only the project owner.

can_copy_fromboolean required

Whether the caller can use this environment as a copy source. Always false for dev environments.

can_deployboolean required

Whether the caller can deploy to this environment manually.

can_use_dev_sessionboolean required

Whether the caller can run a connic dev session in this environment. Only dev environments allow it.

created_atstring date-time required
updated_atstring date-time required
deleted_atstring date-time nullable required

Always null, because deleted environments are not returned.

Changes

No recorded changes to this operation across all 1 revision of this API.