Run pipeline

Prev Next

Available in Classic and VPC

Run a pipeline.

Request

This section describes the request format. The method and URI are as follows:

Method URI
POST /api/v1/project/{projectId}/do

Request headers

For information about the headers common to all SourcePipeline APIs, see SourcePipeline request headers.

Request path parameters

You can use the following path parameters with your request:

Field Type Required Description
projectId String Required Pipeline ID

Request example

The request example is as follows:

curl --location --request POST 'https://vpcsourcepipeline.apigw.ntruss.com/api/v1/project/2***/do' \
--header 'x-ncp-apigw-timestamp: {Timestamp}' \
--header 'x-ncp-iam-access-key: {Access Key}' \
--header 'x-ncp-apigw-signature-v2: {API Gateway Signature}'

Response

This section describes the response format.

Response body

The response body includes the following data:

Field Type Required Description
result Object - Response result
result.historyId Number - Execution job result ID

Response status codes

For information about the HTTP status codes common to all SourcePipeline APIs, see SourcePipeline response status codes.

Response example

The response example is as follows:

{
    "result": {
        "historyId": 54***
    }
}