SourceDeploy overview

Prev Next

Available in Classic and VPC

SourceDeploy is a NAVER Cloud Platform service for deployment automation that automatically deploys and applies newly created or updated sources to servers. The SourceDeploy service provides APIs for stage and scenario configuration by deployment project, scenario deployment, and analysis features in RESTful format.

Common SourceDeploy settings

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

Request

The following describes the common request format.

API URL

The request API URL is as follows:

Classic: https://sourcedeploy.apigw.ntruss.com
VPC: https://vpcsourcedeploy.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)
Content-type Optional Request data format
  • application/json
Accept Optional Response 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

SourceDeploy 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."
    }
}

SourceDeploy API

The following describes the APIs provided by the SourceDeploy service.

API Description
Create project Create a deployment project.
Get project list Get deployment project list.
Delete project Delete a deployment project.
Create stage Create deployment stage in a project.
Get stage list Get deployment stage list.
Get stage Get deployment stage details.
Edit stage Change deployment stage settings.
Delete stage Delete deployment stage.
Create scenario Create deployment scenario in a stage.
Get scenario list Get deployment scenario list.
Get scenario Get deployment scenario details.
Reject scenario deployment Reject scenario deployment.
Approve scenario deployment Approve scenario deployment.
Request scenario deployment approval Request scenario deployment approval.
Start scenario deployment Start scenario deployment.
Get scenario deployment history list Get scenario deployment history list.
Get scenario deployment history Get scenario deployment history details.
Cancel scenario deployment Cancel ongoing scenario deployment.
Edit scenario Change deployment scenario settings.
Delete scenario Delete deployment scenario.
Approve canary distribution Approve manually analyzed canary version deployment.
Reject canary distribution Reject manually analyzed canary version deployment.
Get canary analysis step list Get the canary analysis step list.
Get canary analysis report Get canary analysis report.
Get Auto Scaling group list Get the list of available Auto Scaling groups.
Get Kubernetes cluster list Get the list of available Ncloud Kubernetes Service clusters.
Get Object Storage bucket list Get the list of available Object Storage buckets.
Get Object Storage object list Get the list of available Object Storage objects.
Get server list Get the list of available servers.
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 target group list Get the list of load balancer target groups connected to an Auto Scaling group.

SourceDeploy related resources

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