# Pipeline # Pipeline The orchestration primitive that runs the shipping stages as one sequence. The stages exist as separate products — Code, Assess, Build, Deploy, Comply and publication through Marketplace — and this is the thing that runs them in order, as a single automated action against a repository. Keeping the stages independently callable and the sequence separate is what allowed a stage to be run alone. Re-running assessment against a repository without deploying it is a normal operation, not a special mode. What is recorded is the action itself plus the deployment surface behind it — creating a pipeline, deploying it, and the dynamic form that deploys one built for a specific service. ## Operations ### Action `POST` `/run-action` #### Run Action `run_action` Run Action. #### Run Action ##### Other responses `201` ### Operations `POST` `/deployment` #### Run deployment to root Run deployment process for given service from branch to the root account ##### Request body`application/json` 3 fields | Field | Type | Description | | --- | --- | --- | | `branch`required | `string` | Git branch to use | | `environment`required | `string` | can be dev or test | | `project`required | `string` | name of project(repository name) | ##### Response `201``application/json` 3 fields Deployment created | Field | Type | Description | | --- | --- | --- | | `status` | `string` | Status of triggered deployment | | `message` | `string` | Information about deployment | | `execution_id` | `string` | ID of deployment using which user can retrieve status | `GET` `/deployment/{execution_id}/status` #### Get deployment status Get deployment status for the deployment to any account using execution_id ##### Parameters 1 | Parameter | Type | Description | | --- | --- | --- | | `execution_id` required | `string` path | — | ##### Response `200``application/json` 2 fields Status for provided execution | Field | Type | Description | | --- | --- | --- | | `deployment_status` | `string` | Status of deployment | | `description` | `string` | Deployment description | ##### Response `400``application/json` 2 fields Provided execution id does not exists | Field | Type | Description | | --- | --- | --- | | `message` | `string` | Error message | | `description` | `string` | Error description | `POST` `/dynamicDeployment` #### Run deployment on given account Run deployment process for given service from branch at any accoun ##### Request body`application/json` 6 fields | Field | Type | Description | | --- | --- | --- | | `branch`required | `string` | use github sha commit | | `project`required | `string` | name of project(repository name) | | `bucket`required | `string` | name of bucket where place artifacts for sandbox:sandbox-account-artifacts | | `bundle_id`required | `string` | sha commit | | `accessKey`required | `string` | access key for account, ask devops for providing keys | | `secretKey`required | `string` | secret key for account, ask devops for providing keys | ##### Other responses `200` `POST` `/v3/deployments` #### Start deployment pipeline Deploy service to a given account ##### Request body`application/json` 6 fields | Field | Type | Description | | --- | --- | --- | | `project_name`required | `string` | name of github repository | | `access_key`required | `string` | environment credentials | | `secret_key`required | `string` | environment credentials | | `env` | `string` | — | | `branch` | `string` | branch to be deployed if different from master | | `domain_name`required | `string (hostname)` | domain name of the environment to deploy | ##### Response `201``application/json` 1 fields Pipeline execution created | Field | Type | Description | | --- | --- | --- | | `bundle_id` | `string (uuid)` | — | ##### Other responses `400` `GET` `/v3/deployments/{bundle_id}` #### Get status of current deployment ##### Parameters 1 | Parameter | Type | Description | | --- | --- | --- | | `bundle_id` required | `string (uuid)` path | — | ##### Response `200``application/json` 2 fields Deployment status | Field | Type | Description | | --- | --- | --- | | `bundle_id` | `string (uuid)` | — | | `status` | `string` | — | ##### Other responses `404` ## Errors `400``404` ## More in Shipping - Previous product: Health