github.com/NaverCloudPlatform/ncloud-sdk-go-v2@v1.6.13/services/vsourcepipeline/docs/V1Api.md (about) 1 # \V1Api 2 3 All URIs are relative to *https://vpcsourcepipeline.apigw.ntruss.com/api/v1* 4 5 Method | HTTP request | Description 6 ------------- | ------------- | ------------- 7 [**GetProjects**](V1Api.md#GetProjects) | **Get** /project | 8 [**CreateProject**](V1Api.md#CreateProject) | **Post** /project | 9 [**DeleteProject**](V1Api.md#DeleteProject) | **Delete** /project/{projectId} | 10 [**StartProject**](V1Api.md#StartProject) | **Post** /project/{projectId}/do | 11 [**GetProject**](V1Api.md#GetProject) | **Get** /project/{projectId} | 12 [**GetProjectHistories**](V1Api.md#GetProjectHistories) | **Get** /project/{projectId}/history | 13 [**CancelProject**](V1Api.md#CancelProject) | **Post** /project/{projectId}/history/{historyId}/cancel | 14 [**GetProjectHistory**](V1Api.md#GetProjectHistory) | **Get** /project/{projectId}/history/{historyId} | 15 [**ChangeProject**](V1Api.md#ChangeProject) | **Patch** /project/{projectId} | 16 [**GetSourcebuildProjects**](V1Api.md#GetSourcebuildProjects) | **Get** /sourcebuild/project | 17 [**GetSourcecommitRepositories**](V1Api.md#GetSourcecommitRepositories) | **Get** /sourcecommit/repository | 18 [**GetSourcecommitRepositoryBranches**](V1Api.md#GetSourcecommitRepositoryBranches) | **Get** /sourcecommit/repository/{repositoryName}/branch | 19 [**GetSourcedeployProjects**](V1Api.md#GetSourcedeployProjects) | **Get** /sourcedeploy/project | 20 [**GetSourcedeployProjectStages**](V1Api.md#GetSourcedeployProjectStages) | **Get** /sourcedeploy/project/{projectId}/stage | 21 [**GetSourcedeployProjectScenarios**](V1Api.md#GetSourcedeployProjectScenarios) | **Get** /sourcedeploy/project/{projectId}/stage/{stageId}/scenario | 22 [**GetTimeZone**](V1Api.md#GetTimeZone) | **Get** /trigger/timezone | 23 24 25 # **GetProjects** 26 > GetProjectListResponse GetProjects 27 28 ### Return type 29 30 *[**GetProjectListResponse**](GetProjectListResponse.md) 31 32 ### Authorization 33 34 [x-ncp-iam](../README.md#x-ncp-iam) 35 36 ### HTTP request headers 37 38 - **Content-Type**: Not defined 39 - **Accept**: Not defined 40 41 [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) 42 43 # **CreateProject** 44 > CreateProjectResponse CreateProject(createProject) 45 46 47 ### Required Parameters 48 49 Name | Type | Description | Notes 50 ------------- | ------------- | ------------- | ------------- 51 **createProject** | **[\*CreateProject](CreateProject.md)** | 52 53 ### Return type 54 55 *[**CreateProjectResponse**](CreateProjectResponse.md) 56 57 ### Authorization 58 59 [x-ncp-iam](../README.md#x-ncp-iam) 60 61 ### HTTP request headers 62 63 - **Content-Type**: Not defined 64 - **Accept**: Not defined 65 66 [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) 67 68 # **DeleteProject** 69 > DeleteProjectResponse DeleteProject(projectId) 70 71 72 ### Required Parameters 73 74 Name | Type | Description | Notes 75 ------------- | ------------- | ------------- | ------------- 76 **projectId** | **string** | projectId 77 78 ### Return type 79 80 *[**DeleteProjectResponse**](DeleteProjectResponse.md) 81 82 ### Authorization 83 84 [x-ncp-iam](../README.md#x-ncp-iam) 85 86 ### HTTP request headers 87 88 - **Content-Type**: Not defined 89 - **Accept**: Not defined 90 91 [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) 92 93 # **StartProject** 94 > StartPipelineResponse StartProject(projectId) 95 96 97 ### Required Parameters 98 99 Name | Type | Description | Notes 100 ------------- | ------------- | ------------- | ------------- 101 **projectId** | **string** | projectId 102 103 ### Return type 104 105 *[**StartPipelineResponse**](StartPipelineResponse.md) 106 107 ### Authorization 108 109 [x-ncp-iam](../README.md#x-ncp-iam) 110 111 ### HTTP request headers 112 113 - **Content-Type**: Not defined 114 - **Accept**: Not defined 115 116 [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) 117 118 # **GetProject** 119 > GetProjectDetailResponse GetProject(projectId) 120 121 122 ### Required Parameters 123 124 Name | Type | Description | Notes 125 ------------- | ------------- | ------------- | ------------- 126 **projectId** | **string** | projectId 127 128 ### Return type 129 130 *[**GetProjectDetailResponse**](GetProjectDetailResponse.md) 131 132 ### Authorization 133 134 [x-ncp-iam](../README.md#x-ncp-iam) 135 136 ### HTTP request headers 137 138 - **Content-Type**: Not defined 139 - **Accept**: Not defined 140 141 [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) 142 143 # **GetProjectHistories** 144 > GetHistoryListResponse GetProjectHistories(projectId) 145 146 147 ### Required Parameters 148 149 Name | Type | Description | Notes 150 ------------- | ------------- | ------------- | ------------- 151 **projectId** | **string** | projectId 152 153 ### Return type 154 155 *[**GetHistoryListResponse**](GetHistoryListResponse.md) 156 157 ### Authorization 158 159 [x-ncp-iam](../README.md#x-ncp-iam) 160 161 ### HTTP request headers 162 163 - **Content-Type**: Not defined 164 - **Accept**: Not defined 165 166 [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) 167 168 # **CancelProject** 169 > CancelPipelineResponse CancelProject(projectId, historyId) 170 171 172 ### Required Parameters 173 174 Name | Type | Description | Notes 175 ------------- | ------------- | ------------- | ------------- 176 **projectId** | **string** | projectId | **historyId** | **string** | historyId 177 178 ### Return type 179 180 *[**CancelPipelineResponse**](CancelPipelineResponse.md) 181 182 ### Authorization 183 184 [x-ncp-iam](../README.md#x-ncp-iam) 185 186 ### HTTP request headers 187 188 - **Content-Type**: Not defined 189 - **Accept**: Not defined 190 191 [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) 192 193 # **GetProjectHistory** 194 > GetHistoryDetailResponse GetProjectHistory(projectId, historyId) 195 196 197 ### Required Parameters 198 199 Name | Type | Description | Notes 200 ------------- | ------------- | ------------- | ------------- 201 **projectId** | **string** | projectId | **historyId** | **string** | historyId 202 203 ### Return type 204 205 *[**GetHistoryDetailResponse**](GetHistoryDetailResponse.md) 206 207 ### Authorization 208 209 [x-ncp-iam](../README.md#x-ncp-iam) 210 211 ### HTTP request headers 212 213 - **Content-Type**: Not defined 214 - **Accept**: Not defined 215 216 [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) 217 218 # **ChangeProject** 219 > ChangeProjectReponse ChangeProject(changeProject, projectId) 220 221 222 ### Required Parameters 223 224 Name | Type | Description | Notes 225 ------------- | ------------- | ------------- | ------------- 226 **changeProject** | **[\*ChangeProject](ChangeProject.md)** | | **projectId** | **string** | projectId 227 228 ### Return type 229 230 *[**ChangeProjectReponse**](ChangeProjectReponse.md) 231 232 ### Authorization 233 234 [x-ncp-iam](../README.md#x-ncp-iam) 235 236 ### HTTP request headers 237 238 - **Content-Type**: Not defined 239 - **Accept**: Not defined 240 241 [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) 242 243 # **GetSourcebuildProjects** 244 > GetSbProjectResponse GetSourcebuildProjects 245 246 ### Return type 247 248 *[**GetSbProjectResponse**](GetSbProjectResponse.md) 249 250 ### Authorization 251 252 [x-ncp-iam](../README.md#x-ncp-iam) 253 254 ### HTTP request headers 255 256 - **Content-Type**: Not defined 257 - **Accept**: Not defined 258 259 [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) 260 261 # **GetSourcecommitRepositories** 262 > GetScRepositoryResposne GetSourcecommitRepositories 263 264 ### Return type 265 266 *[**GetScRepositoryResposne**](GetScRepositoryResposne.md) 267 268 ### Authorization 269 270 [x-ncp-iam](../README.md#x-ncp-iam) 271 272 ### HTTP request headers 273 274 - **Content-Type**: Not defined 275 - **Accept**: Not defined 276 277 [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) 278 279 # **GetSourcecommitRepositoryBranches** 280 > GetScBranchResponse GetSourcecommitRepositoryBranches(repositoryName) 281 282 283 ### Required Parameters 284 285 Name | Type | Description | Notes 286 ------------- | ------------- | ------------- | ------------- 287 **repositoryName** | **string** | repositoryName 288 289 ### Return type 290 291 *[**GetScBranchResponse**](GetScBranchResponse.md) 292 293 ### Authorization 294 295 [x-ncp-iam](../README.md#x-ncp-iam) 296 297 ### HTTP request headers 298 299 - **Content-Type**: Not defined 300 - **Accept**: Not defined 301 302 [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) 303 304 # **GetSourcedeployProjects** 305 > GetSdProjectResponse GetSourcedeployProjects 306 307 ### Return type 308 309 *[**GetSdProjectResponse**](GetSdProjectResponse.md) 310 311 ### Authorization 312 313 [x-ncp-iam](../README.md#x-ncp-iam) 314 315 ### HTTP request headers 316 317 - **Content-Type**: Not defined 318 - **Accept**: Not defined 319 320 [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) 321 322 # **GetSourcedeployProjectStages** 323 > GetSdStageResponse GetSourcedeployProjectStages(projectId) 324 325 ### Required Parameters 326 327 Name | Type | Description | Notes 328 ------------- | ------------- | ------------- | ------------- 329 **projectId** | **string** | projectId 330 331 ### Return type 332 333 *[**GetSdStageResponse**](GetSdStageResponse.md) 334 335 ### Authorization 336 337 [x-ncp-iam](../README.md#x-ncp-iam) 338 339 ### HTTP request headers 340 341 - **Content-Type**: Not defined 342 - **Accept**: Not defined 343 344 [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) 345 346 # **GetSourcedeployProjectScenarios** 347 > GetSdScenarioResponse GetSourcedeployProjectScenarios(projectId, stageId) 348 349 ### Required Parameters 350 351 Name | Type | Description | Notes 352 ------------- | ------------- | ------------- | ------------- 353 **projectId** | **string** | projectId | **stageId** | **string** | stageId 354 355 ### Return type 356 357 *[**GetSdScenarioResponse**](GetSdScenarioResponse.md) 358 359 ### Authorization 360 361 [x-ncp-iam](../README.md#x-ncp-iam) 362 363 ### HTTP request headers 364 365 - **Content-Type**: Not defined 366 - **Accept**: Not defined 367 368 [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) 369 370 # **GetTimeZone** 371 > GetTimeZone GetTimeZone 372 373 ### Return type 374 375 *[**GetTimeZone**](GetTimeZone.md) 376 377 ### Authorization 378 379 [x-ncp-iam](../README.md#x-ncp-iam) 380 381 ### HTTP request headers 382 383 - **Content-Type**: Not defined 384 - **Accept**: Not defined 385 386 [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)