deployments

Activate deployment

Makes a deployment with status deployed the live version for its environment.

Connectors declared in code are restored to the deployment's connector files. If a connector change fails, returns 409 and nothing is activated unless force is set.

Required permission: deployments.activate.

post/v1/projects/{project_id}/deployments/{deployment_id}/activate

Request

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

Path parameters

project_idstring uuid required

ID of the project the API key belongs to.

deployment_idstring uuid required

Deployment ID from GET /deployments.

Query parameters

forceboolean

Activate even if some connector changes from connectors/*.yaml fail; failing connectors keep their current state

Response

Successful Response

okboolean required

Whether the operation succeeded.

Changes

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