deployments

Create deployment

Creates a deployment from the project's connected git repository.

Builds the latest commit on the environment's git_branch, or on the repository's default branch when the environment has none. Only works for projects with a git provider connected; other projects return 400. For projects without git, deploy with connic deploy from the CLI. Older pending or building deployments in the same environment are cancelled.

Required permission: deployments.create.

post/v1/projects/{project_id}/deployments

Request

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

Path parameters

project_idstring uuid required

ID of the project the API key belongs to.

Query parameters

environment_idstring uuid required

Environment to deploy to

Request body

skip_testsboolean

Skip the deploy-gate test phase for this deployment.

Response

Successful Response

idstring uuid required
project_idstring uuid required

Project the deployment belongs to.

environment_idstring uuid required

Environment the deployment belongs to.

commit_hashstring nullable required

Git commit or ref that was built. null for CLI uploads.

source_type'git' | 'cli_upload' required

git for builds from the connected repository, cli_upload for code uploaded with the CLI.

status'pending' | 'building' | 'deployed' | 'failed' | 'blocked' | 'cancelled' required

Deployment state: pending until the build starts, building while it builds, tests and activates, then deployed, failed or cancelled.

is_activeboolean required

Whether this deployment currently serves the environment.

agents_metadatastring required

JSON-encoded array with the configuration of each agent found in the code. [] until the build discovers agents.

agents_countinteger required

Number of agents in the deployment.

tools_countinteger required

Number of distinct tools referenced by the agents.

middlewares_countinteger required

Number of middleware modules found.

guardrails_countinteger required

Number of distinct guardrail types used by the agents.

logsstring nullable required

Build and activation log output. null until the build writes output.

created_atstring date-time required
started_atstring date-time nullable required

When the build started. null while pending.

ended_atstring date-time nullable required

When the deployment finished, failed or was cancelled.

testing_started_atstring date-time nullable required

When the test phase started. null if it has not run.

deploy_started_atstring date-time nullable required

When activation started. null if it has not started.

tests_status'running' | 'passed' | 'failed' | 'skipped' | 'cancelled' nullable required

Result of the deploy-gate test phase. null when tests have not run or the code has no tests.

skip_testsboolean required

Whether the deploy-gate test phase was skipped for this deployment.

connic_triggeredboolean required

Whether Connic started this deployment on the project's behalf.

kind'deploy' | 'dev_session' | 'test_run' required

deploy for a regular deployment, dev_session for code synced by connic dev, test_run for a build that only runs tests.

current_phasestring nullable required

Current phase: building, testing, deploying, active or done. null before the build starts.

connectors_status'applied' | 'partial' | 'failed' nullable

Result of applying the connectors declared in code: applied, partial when some failed and kept their previous state, or failed. null until connectors are applied.

skip_failed_connectorsboolean

Whether connectors declared in code that fail to apply keep their previous state instead of failing the deployment.

Changes

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