Builds

APIs for managing builds are currently available for developers to preview. During the preview period, the API may change without advance notice.

Start a new build

POST /builds

Parameters

NameTypeDescription
appIdstringRequired. The application identifier.
workflowIdstringRequired. The workflow identifier as specified in YAML file.
branchstringRequired. The branch name.

Example

{
    "appId": "5c9c064185dd2310123b8e96",
    "workflowId": "release",
    "branch": "master"
}

Response

{
    "application": {
        "_id": "5c9c064185dd2310123b8e96",
        "appName": "my-repo"
    },
    "build": {
        "_id": "5c9c025185ed4300133b2a17",
        "appId": "5c9c064185dd2310123b8e96",
        "branch": "master",
        "index": 1,
        "status": "queued"
    }
}

Cancel build

POST /builds/:id/cancel

The request will return 208 Already Reported if the build has already finished.