POST /run-action Run Action
run_action
Run Action.
Run Action
Other responses
201
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
Operations
POST /deployment Run deployment to root
Run deployment process for given service from branch to the root account
Request bodyapplication/json
3 fields
application/json| Field | Type | Description |
|---|---|---|
branchrequired | string | Git branch to use |
environmentrequired | string | can be dev or test |
projectrequired | string | name of project(repository name) |
Response 201application/json
3 fields
201application/jsonDeployment 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 200application/json
2 fields
200application/jsonStatus for provided execution
| Field | Type | Description |
|---|---|---|
deployment_status | string | Status of deployment |
description | string | Deployment description |
Response 400application/json
2 fields
400application/jsonProvided 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 bodyapplication/json
6 fields
application/json| Field | Type | Description |
|---|---|---|
branchrequired | string | use github sha commit |
projectrequired | string | name of project(repository name) |
bucketrequired | string | name of bucket where place artifacts for sandbox:sandbox-account-artifacts |
bundle_idrequired | string | sha commit |
accessKeyrequired | string | access key for account, ask devops for providing keys |
secretKeyrequired | 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 bodyapplication/json
6 fields
application/json| Field | Type | Description |
|---|---|---|
project_namerequired | string | name of github repository |
access_keyrequired | string | environment credentials |
secret_keyrequired | string | environment credentials |
env | string | — |
branch | string | branch to be deployed if different from master |
domain_namerequired | string (hostname) | domain name of the environment to deploy |
Response 201application/json
1 fields
201application/jsonPipeline 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 200application/json
2 fields
200application/jsonDeployment status
| Field | Type | Description |
|---|---|---|
bundle_id | string (uuid) | — |
status | string | — |
Other responses
404
Errors
400404