SourcePipeline overview

Prev Next

Available in Classic and VPC

SourcePipeline is a NAVER Cloud Platform service that integrates SourceCommit, SourceBuild, and SourceDeploy services to automate the software release process leading to repository, build, and deployment. The SourcePipeline service provides APIs for pipeline creation and execution features in RESTful form.

Common SourcePipeline settings

The following describes commonly used request and response formats in SourcePipeline APIs.

Request

The following describes the common request format.

API URL

The request API URL is as follows:

Classic: https://sourcepipeline.apigw.ntruss.com
VPC: https://vpcsourcepipeline.apigw.ntruss.com
Note

Classic environment is only supported in the Korea Region.

Request headers

The following describes the request headers.

Field Required Description
x-ncp-apigw-timestamp Required This is the number of milliseconds that have elapsed since January 1, 1970 00:00:00 UTC.
  • Request is considered invalid if the timestamp differs from the current time by more than 5 minutes.
x-ncp-iam-access-key Required Access key issued on NAVER Cloud Platform
x-ncp-apigw-signature-v2 Required Base64-encoded signature that encrypts the request information with a secret key that maps to the access key issued on NAVER Cloud Platform, using the HMAC encryption algorithm (HmacSHA256)
x-ncp-region_code Optional Code of Region to use the service
  • KR (default)
Accept Optional Response data format
  • application/json
Content-type Optional Request data format
  • application/json

Response

The following describes the common response format.

Response body

The response body includes the following data:

error
error defines the API call failure information. The following describes error.

Field Type Required Description
error Object - Error code and message
error.errorCode String Required Error code
error.message String Required Error message
error.details String Required Error message detailed description

Response status codes

SourcePipeline APIs use NAVER Cloud Platform's common response status codes. For response status codes common to NAVER Cloud Platform, see Ncloud API response status codes.

Response example

For response examples when a call is successful, see each API specification. The following is a sample response upon a failed call.

{
    "error": {
        "errorCode": "200",
        "message": "Authentication Failed",
        "details": "Invalid authentication information."
    }
}

SourcePipeline API

The following describes the APIs provided by the SourcePipeline service.

API Description
Create pipeline Create a pipeline.
Get pipeline list Get the pipeline list.
Get pipeline Get pipeline details.
Get pipeline execution history list Get pipeline execution history.
Get pipeline execution history Get pipeline execution history details.
Get pipeline reserved trigger time zone Get the list of applicable time zones when setting up a pipeline's reserved trigger.
Edit pipeline Change pipeline settings.
Run pipeline Run pipeline.
Cancel pipeline execution Cancel execution of a pipeline in execution.
Delete pipeline Delete a pipeline.
Get SourceCommit repository list Get the list of available SourceCommit repositories.
Get SourceCommit branch list Get the list of available SourceCommit repository branches.
Get SourceBuild project list Get the list of available SourceBuild projects.
Get SourceDeploy stage list Get the list of available deployment stages in a SourceDeploy project.
Get SourceDeploy scenario list Get the list of available deployment stages in a SourceDeploy project.
Get SourceDeploy project list Get the list of available SourceDeploy projects.

SourcePipeline related resources

NAVER Cloud Platform provides a variety of related resources to help users better understand SourcePipeline APIs.