Create a build

Create a build

Create a build.

POST/v1/build

Query parameters

Body

application/json

accountSeqinteger

Account number (your system's account number)

Example: 1

autotagUseYnstring

automatic tagging usage status (enabled: Y, unused: N)

Example: "N"

autotagPrefixstring

Example: "test"

autotagSeqTypestring

autotag sequence number type('DATETIME' or 'SEQUENCE')

Example: "DATETIME"

buildSteps*array of object

List of buildSteps setup information

descriptionstring

Example: "build test"

editType*string

Edit type (New: N)

Example: "N"

externalRegistrySeqinteger

External registry number (number of the external registry to store build images).

Example: 0

imageNamestring

Image name (name of the image to be built)

Example: "build-api-test-gradle"

registryNamestring

Registry name (name of the registry to store the build image)

Example: "dev"

registryProjectIdinteger

Registry project ID (project ID of the registry to store the build image)

Example: 27

tagNamestring

Image tag name (tag name of the image to be built)

Example: "8u292-rmsoft"

Response

200

OK

Body

*/*

useYnstring

Usage status (Enabled: Y, Disabled: N)

Example: "Y"

createdstring

creation time

Example: "2022-12-02 08:42:46"

updatedstring

update time

Example: "2022-12-02 08:42:46"

buildSeqinteger

Example: 1

buildNointeger

Example: 1

buildNamestring

Example: "build-test"

buildDescstring

Example: "build test"

accountSeqinteger

Account number (system's account number).

Example: 1

registryProjectIdinteger

Registry project ID (project ID for the registry to store the build image).

Example: 27

registryNamestring

Registry name (name of the registry to store the build image).

Example: "dev"

imageNamestring

Image name (name of the image to be built)

Example: "build-api-test-gradle"

autotagUseYnstring

Automatic tagging usage status (Enabled: Y, Disabled: N).

Example: "N"

autotagPrefixstring

Example: "test"

autotagSeqTypestring

autotag sequence number type('DATETIME' or 'SEQUENCE')

Example: "DATETIME"

tagNamestring

Image tag name (tag name of the image to be built)

Example: "8u292-rmsoft"

externalRegistrySeqinteger

External registry number (number of the external registry to store the build image).

Example: 0

buildServerHoststring

Build server host (information about the server host where actual build steps are executed and images are generated)

Example: "topic:build-20230623-ws-namespace-thingcluster"

buildServerTlsVerifystring

Whether TLS is used on the server where the actual build is executed (Enabled: Y, Disabled: N).

Example: "N"

buildServerCacrtstring

TLS CA for the build execution server (CA value for TLS integration on the server where the actual build is executed).

Example: ""

buildServerClientCertstring

Client certificate for the build execution server(Client certificate for TLS integration on the server where the actual build is executed.)

Example: ""

buildServerClientKeystring

Client key for the build execution server.(Client key for TLS integration on the server where the actual build is executed.)

Example: ""

buildStepsarray of object

List of buildsteps configuration information

hostUrlstring

Client key for the build execution server.(Client key for TLS integration on the server where the actual build is executed.)

Example: "dev.cocktailcloud.io"

buildCountinteger

Example: 6

runningCountinteger

Example: 6

doneCountinteger

Example: 3

errorCountinteger

Example: 3

pipelineCountinteger

Number of connections associated with image updates.

Example: 1

tagCountinteger

Example: 3

buildTimeAvginteger

Average build time (seconds) for successful builds

Example: 606

imgSizeAvginteger

Average image size (bytes) for successful builds

Example: 351720643

latestBuildTimeinteger

Recent build time (seconds) for successful builds

Example: 752

latestImgSizeinteger

Recent image size (bytes) for successful builds.

Example: 352886544

latestExecTimestring

Example: "2022-12-02 08:42:46"

Request

JavaScriptCurlPythonHTTP

const response = await fetch('/v1/build', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "buildSteps": [
        {
          "stepType": "CODE_DOWN",
          "useFlag": true,
          "buildStepSeq": 0,
          "buildStepConfig": {
            "stepType": "CODE_DOWN",
            "repositoryType": "GIT",
            "stepTitle": "Code repository task",
            "repositoryUrl": "github.com/codefresh-contrib/gradle-sample-app.git",
            "branchName": "master",
            "codeSaveDir": "repo",
            "commonType": "COMMON",
            "protocolType": "https"
          },
          "stepOrder": 1
        },
        {
          "stepType": "USER_TASK",
          "useFlag": true,
          "buildStepSeq": 1,
          "buildStepConfig": {
            "stepType": "USER_TASK",
            "stepTitle": "user task",
            "cmd": [
              "mvn",
              "clean",
              "install"
            ],
            "workingDir": "/build",
            "imageName": "build-api-test-gradle",
            "imageTag": "8u292-rmsoft",
            "dockerVolumeMountVOList": [
              {
                "containerPath": "/build",
                "hostPath": "$PWD/repo"
              }
            ]
          },
          "stepOrder": 2
        },
        {
          "stepType": "FTP",
          "useFlag": true,
          "buildStepSeq": 2,
          "buildStepConfig": {
            "stepType": "FTP",
            "stepTitle": "file(FTP) task",
            "url": "test-ftp.gradle-sample-test",
            "ftpType": "SFTP",
            "username": "runapps",
            "sourceFiles": "/data/dataset",
            "remoteDirectory": "data/gradle-sample-dataset",
            "ftpExecType": "DIR_FTP_DOWN"
          },
          "stepOrder": 1
        },
        {
          "stepType": "HTTP",
          "useFlag": true,
          "buildStepSeq": 3,
          "buildStepConfig": {
            "stepType": "CODE_DOWN",
            "repositoryType": "GIT",
            "stepTitle": "Source Download",
            "repositoryUrl": "github.com/codefresh-contrib/gradle-sample-app.git",
            "branchName": "master",
            "codeSaveDir": "repo",
            "commonType": "COMMON",
            "protocolType": "https"
          },
          "stepOrder": 3
        },
        {
          "stepType": "SHELL",
          "useFlag": true,
          "buildStepSeq": 4,
          "buildStepConfig": {
            "stepType": "SHELL",
            "stepTitle": "Script task.",
            "shellType": "SCRIPT",
            "command": "echo \">>> move app source \"\ncd repo\n\necho \">>> node_modules Compression\"\ntar -cf node_modules.tar node_modules/\n\nls -al"
          },
          "stepOrder": 4
        },
        {
          "stepType": "CREATE_IMAGE",
          "useFlag": true,
          "buildStepSeq": 5,
          "buildStepConfig": {
            "stepType": "CREATE_IMAGE",
            "buildStepSeq": 5,
            "exitCode": "0",
            "dockerFileType": "CONTENTS",
            "stepTitle": "Image Build task",
            "dockerFile": "FROM gradle:6.9.2-jdk8",
            "severity": "",
            "registryId": 27,
            "registryName": "dev",
            "imageTag": "8u292-rmsoft",
            "imageName": "buildapi-test-gradle"
          },
          "stepOrder": 5
        }
      ],
      "editType": "N"
    }),
});
const data = await response.json();

Response

200

[
  {
    "useYn": "Y",
    "created": "2022-12-02 08:42:46",
    "updated": "2022-12-02 08:42:46",
    "buildSeq": 1,
    "buildNo": 1,
    "buildName": "build-test",
    "buildDesc": "build test",
    "accountSeq": 1,
    "registryProjectId": 27,
    "registryName": "dev",
    "imageName": "build-api-test-gradle",
    "autotagUseYn": "N",
    "autotagPrefix": "test",
    "autotagSeqType": "DATETIME",
    "tagName": "8u292-rmsoft",
    "externalRegistrySeq": 0,
    "buildServerHost": "topic:build-20230623-ws-namespace-thingcluster",
    "buildServerTlsVerify": "N",
    "buildServerCacrt": "",
    "buildServerClientCert": "",
    "buildServerClientKey": "",
    "buildSteps": [
      {
        "stepType": "CODE_DOWN",
        "useFlag": true,
        "buildStepSeq": 0,
        "buildStepConfig": {
          "stepType": "CODE_DOWN",
          "repositoryType": "GIT",
          "stepTitle": "Code repository task.",
          "repositoryUrl": "github.com/codefresh-contrib/gradle-sample-app.git",
          "branchName": "master",
          "codeSaveDir": "repo",
          "commonType": "COMMON",
          "protocolType": "https"
        },
        "stepOrder": 1
      },
      {
        "stepType": "USER_TASK",
        "useFlag": true,
        "buildStepSeq": 0,
        "buildStepConfig": {
          "stepType": "USER_TASK",
          "stepTitle": "user task.",
          "cmd": [
            "mvn",
            "clean",
            "install"
          ],
          "workingDir": "/build",
          "imageName": "build-api-test-gradle",
          "imageTag": "8u292-rmsoft",
          "dockerVolumeMountVOList": [
            {
              "containerPath": "/build",
              "hostPath": "$PWD/repo"
            }
          ]
        },
        "stepOrder": 2
      },
      {
        "stepType": "FTP",
        "useFlag": true,
        "buildStepSeq": 110,
        "buildStepConfig": {
          "stepType": "FTP",
          "stepTitle": "file(FTP) task.",
          "url": "test-ftp.gradle-sample-test",
          "ftpType": "SFTP",
          "username": "runapps",
          "sourceFiles": "/data/dataset",
          "remoteDirectory": "data/gradle-sample-dataset",
          "ftpExecType": "DIR_FTP_DOWN"
        },
        "stepOrder": 3
      },
      {
        "stepType": "HTTP",
        "useFlag": true,
        "buildStepSeq": 0,
        "buildStepConfig": {
          "stepType": "HTTP",
          "stepTitle": "REST call task",
          "url": "https://priv-regi.cocktailcloud.io/api/gradle-sample-dataset",
          "httpMode": "GET",
          "ignoreSslErrors": false,
          "username": "admin",
          "timeout": 5,
          "validResponseCodes": "200",
          "outputFile": "project-list.txt",
          "consoleLogResponseBody": false
        },
        "stepOrder": 4
      },
      {
        "stepType": "SHELL",
        "useFlag": true,
        "buildStepSeq": 0,
        "buildStepConfig": {
          "stepType": "SHELL",
          "stepTitle": "script task",
          "shellType": "SCRIPT",
          "command": "echo \">>> move app source\"\ncd repo\n\necho \">>> node_modules compression\"\ntar -cf node_modules.tar node_modules/\n\nls -al"
        },
        "stepOrder": 5
      },
      {
        "stepType": "CREATE_IMAGE",
        "useFlag": true,
        "buildStepSeq": 0,
        "buildStepConfig": {
          "stepType": "CREATE_IMAGE",
          "buildStepSeq": 0,
          "exitCode": "0",
          "dockerFileType": "CONTENTS",
          "stepTitle": "image build task",
          "dockerFile": "FROM gradle:6.9.2-jdk8",
          "severity": "",
          "registryId": 27,
          "registryName": "dev",
          "imageTag": "8u292-rmsoft",
          "imageName": "build-api-test-gradle"
        },
        "stepOrder": 6
      }
    ],
    "hostUrl": "dev.cocktailcloud.io",
    "buildCount": 6,
    "runningCount": 6,
    "doneCount": 3,
    "errorCount": 3,
    "pipelineCount": 1,
    "tagCount": 3,
    "buildTimeAvg": 606,
    "imgSizeAvg": 351720643,
    "latestBuildTime": 752,
    "latestImgSize": 352886544,
    "latestExecTime": "2022-12-02 08:42:46"
  }
]