Available in Classic and VPC
SourceBuild is a NAVER Cloud Platform service that allows you to easily build source code developed in various languages. The SourceBuild service provides APIs for project creation, configuration, and build execution in RESTful format.
Common SourceBuild settings
The following describes commonly used request and response formats in SourceBuild APIs.
Request
The following describes the common request format.
API URL
The request API URL is as follows:
https://sourcebuild.apigw.ntruss.com
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.
|
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
|
Content-type |
Optional | Request data format
|
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
SourceBuild API uses 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."
}
}
SourceBuild API
The following describes the APIs provided by the SourceBuild service.
API | Description |
---|---|
Create project | Create a SourceBuild project. |
Get project list | Get SourceBuild project list. |
Get project | Get SourceBuild project details. |
Edit project | Change SourceBuild project settings. |
Delete project | Delete a project. |
Start build | Start a build. |
Get build history | Get build history. |
Cancel build | Cancel a build. |
Get operating system list | Get operating system list. |
Get computing type list | Get computing type list. |
Get runtime type list | Get runtime type list. |
Get runtime version list | Get runtime version list. |
Get Docker engine list | Get Docker engine list. |
Get SourceCommit repository list | Get SourceCommit repository list. |
Get SourceCommit branch list | Get SourceCommit branch. |
Get Object Storage bucket list | Get Object Storage bucket list. |
Get Container Registry list | Get Container Registry list. |
SourceBuild related resources
NAVER Cloud Platform provides a variety of related resources to help users better understand SourceBuild APIs.
- SourceBuild API guides
- Create signature: how to create a signature to add to the request header
- Sub Account User Guides: how to issue the access key to be added to the request header
- Common Ncloud response status codes: information on common response status codes of NAVER Cloud Platform used by the SourceBuild service
- How to use the SourceBuild service
- SourceBuild User Guide: how to use SourceBuild in the NAVER Cloud Platform console
- Ncloud use environment guide: guide for VPC and Classic environments and support availability
- Introduction to pricing, characteristics, and detailed features: summary of pricing system, characteristics, and detailed features of SourceBuild
- Latest service news: the latest news on SourceBuild
- FAQ: frequently asked questions from SourceBuild users
- Support: Send direct inquiries for unresolved questions that aren't answered by the user guides.