github.com/NaverCloudPlatform/ncloud-sdk-go-v2@v1.6.13/services/sourcebuild/docs/V1Api.md (about)

     1  # \V1Api
     2  
     3  All URIs are relative to *https://sourcebuild.apigw.ntruss.com/api/v1*
     4  
     5  Method | HTTP request | Description
     6  ------------- | ------------- | -------------
     7  [**GetContainerRegistry**](V1Api.md#GetContainerRegistry) | **Get** /containerregistry/registry | 
     8  [**GetComputeEnv**](V1Api.md#GetComputeEnv) | **Get** /env/compute | 
     9  [**GetDockerEnv**](V1Api.md#GetDockerEnv) | **Get** /env/docker | 
    10  [**GetOsEnv**](V1Api.md#GetOsEnv) | **Get** /env/os | 
    11  [**GetRuntimeEnv**](V1Api.md#GetRuntimeEnv) | **Get** /env/os/{osId}/runtime | 
    12  [**GetRuntimeVersionEnv**](V1Api.md#GetRuntimeVersionEnv) | **Get** /env/os/{osId}/runtime/{runtimeId}/version | 
    13  [**GetObjectstorageBucket**](V1Api.md#GetObjectstorageBucket) | **Get** /objectstorage/bucket | 
    14  [**GetProjects**](V1Api.md#GetProjects) | **Get** /project | 
    15  [**CreateProject**](V1Api.md#CreateProject) | **Post** /project | 
    16  [**CancelBuild**](V1Api.md#CancelBuild) | **Delete** /project/{projectId}/build | 
    17  [**StartBuild**](V1Api.md#StartBuild) | **Post** /project/{projectId}/build | 
    18  [**DeleteProject**](V1Api.md#DeleteProject) | **Delete** /project/{projectId} | 
    19  [**GetProject**](V1Api.md#GetProject) | **Get** /project/{projectId} | 
    20  [**GetBuildHistory**](V1Api.md#GetBuildHistory) | **Get** /project/{projectId}/history | 
    21  [**ChangeProject**](V1Api.md#ChangeProject) | **Patch** /project/{projectId} | 
    22  [**GetSourcecommitRepositories**](V1Api.md#GetSourcecommitRepositories) | **Get** /sourcecommit/repository | 
    23  [**GetSourcecommitRepositoryBranches**](V1Api.md#GetSourcecommitRepositoryBranches) | **Get** /sourcecommit/repository/{repositoryName}/branch | 
    24  
    25  
    26  # **GetContainerRegistry**
    27  > GetContainerRegistryResponse GetContainerRegistry()
    28  
    29  
    30  ### Required Parameters
    31  
    32  This endpoint does not need any parameter.
    33  
    34  ### Return type
    35  
    36  *[**GetContainerRegistryResponse**](GetContainerRegistryResponse.md)
    37  
    38  ### Authorization
    39  
    40  [x-ncp-iam](../README.md#x-ncp-iam)
    41  
    42  ### HTTP request headers
    43  
    44   - **Content-Type**: application/json
    45   - **Accept**: application/json
    46  
    47  [[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)
    48  
    49  # **GetComputeEnv**
    50  > GetComputeEnvResponse GetComputeEnv()
    51  
    52  
    53  ### Required Parameters
    54  
    55  This endpoint does not need any parameter.
    56  
    57  ### Return type
    58  
    59  *[**GetComputeEnvResponse**](GetComputeEnvResponse.md)
    60  
    61  ### Authorization
    62  
    63  [x-ncp-iam](../README.md#x-ncp-iam)
    64  
    65  ### HTTP request headers
    66  
    67   - **Content-Type**: application/json
    68   - **Accept**: application/json
    69  
    70  [[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)
    71  
    72  # **GetDockerEnv**
    73  > GetDockerEnvResponse GetDockerEnv()
    74  
    75  
    76  ### Required Parameters
    77  
    78  This endpoint does not need any parameter.
    79  
    80  ### Return type
    81  
    82  *[**GetDockerEnvResponse**](GetDockerEnvResponse.md)
    83  
    84  ### Authorization
    85  
    86  [x-ncp-iam](../README.md#x-ncp-iam)
    87  
    88  ### HTTP request headers
    89  
    90   - **Content-Type**: application/json
    91   - **Accept**: application/json
    92  
    93  [[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)
    94  
    95  # **GetOsEnv**
    96  > GetOsEnvResponse GetOsEnv()
    97  
    98  
    99  ### Required Parameters
   100  
   101  This endpoint does not need any parameter.
   102  
   103  ### Return type
   104  
   105  *[**GetOsEnvResponse**](GetOsEnvResponse.md)
   106  
   107  ### Authorization
   108  
   109  [x-ncp-iam](../README.md#x-ncp-iam)
   110  
   111  ### HTTP request headers
   112  
   113   - **Content-Type**: application/json
   114   - **Accept**: application/json
   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  # **GetRuntimeEnv**
   119  > GetRuntimeEnvResponse GetRuntimeEnv(osId)
   120  
   121  
   122  ### Required Parameters
   123  
   124  Name | Type | Description  | Notes
   125  ------------- | ------------- | ------------- | -------------
   126  **osId** | **string** | osId |
   127  
   128  ### Return type
   129  
   130  *[**GetRuntimeEnvResponse**](GetRuntimeEnvResponse.md)
   131  
   132  ### Authorization
   133  
   134  [x-ncp-iam](../README.md#x-ncp-iam)
   135  
   136  ### HTTP request headers
   137  
   138   - **Content-Type**: application/json
   139   - **Accept**: application/json
   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  # **GetRuntimeVersionEnv**
   144  > GetRuntimeVersionEnvResponse GetRuntimeVersionEnv(osId, runtimeId)
   145  
   146  
   147  ### Required Parameters
   148  
   149  Name | Type | Description  | Notes
   150  ------------- | ------------- | ------------- | -------------
   151  **osId** | **string** | osId | **runtimeId** | **string** | runtimeId |
   152  
   153  ### Return type
   154  
   155  *[**GetRuntimeVersionEnvResponse**](GetRuntimeVersionEnvResponse.md)
   156  
   157  ### Authorization
   158  
   159  [x-ncp-iam](../README.md#x-ncp-iam)
   160  
   161  ### HTTP request headers
   162  
   163   - **Content-Type**: application/json
   164   - **Accept**: application/json
   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  # **GetObjectstorageBucket**
   169  > GetObjsBucketResponse GetObjectstorageBucket()
   170  
   171  
   172  ### Required Parameters
   173  
   174  This endpoint does not need any parameter.
   175  
   176  ### Return type
   177  
   178  *[**GetObjsBucketResponse**](GetObjsBucketResponse.md)
   179  
   180  ### Authorization
   181  
   182  [x-ncp-iam](../README.md#x-ncp-iam)
   183  
   184  ### HTTP request headers
   185  
   186   - **Content-Type**: application/json
   187   - **Accept**: application/json
   188  
   189  [[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)
   190  
   191  # **GetProjects**
   192  > GetProjectListResponse GetProjects(optional)
   193  
   194  
   195  ### Optional Parameters
   196  Optional parameters are passed through a map[string]interface{}.
   197  The keys are pageNo, pageSize and projectName.
   198  
   199  Name | Type | Description  | Notes
   200  ------------- | ------------- | ------------- | -------------
   201  **pageNo** | **string** | Page No |
   202  **pageSize** | **string** | Page Size |
   203  **projectName** | **string** | Project Name |
   204  
   205  ### Return type
   206  
   207  *[**GetProjectListResponse**](GetProjectListResponse.md)
   208  
   209  ### Authorization
   210  
   211  [x-ncp-iam](../README.md#x-ncp-iam)
   212  
   213  ### HTTP request headers
   214  
   215   - **Content-Type**: application/json
   216   - **Accept**: application/json
   217  
   218  [[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)
   219  
   220  # **CreateProject**
   221  > CreateProjectResponse CreateProject(body)
   222  
   223  
   224  ### Required Parameters
   225  
   226  Name | Type | Description  | Notes
   227  ------------- | ------------- | ------------- | -------------
   228  **body** | **[\*CreateProject](CreateProject.md)** |  |
   229  
   230  ### Return type
   231  
   232  *[**CreateProjectResponse**](CreateProjectResponse.md)
   233  
   234  ### Authorization
   235  
   236  [x-ncp-iam](../README.md#x-ncp-iam)
   237  
   238  ### HTTP request headers
   239  
   240   - **Content-Type**: application/json
   241   - **Accept**: application/json
   242  
   243  [[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)
   244  
   245  # **CancelBuild**
   246  > CancelBuild(body, projectId)
   247  
   248  
   249  ### Required Parameters
   250  
   251  Name | Type | Description  | Notes
   252  ------------- | ------------- | ------------- | -------------
   253  **body** | **[\*CancelBuild](CancelBuild.md)** |  | **projectId** | **string** | projectId |
   254  
   255  ### Return type
   256  
   257   (empty response body)
   258  
   259  ### Authorization
   260  
   261  [x-ncp-iam](../README.md#x-ncp-iam)
   262  
   263  ### HTTP request headers
   264  
   265   - **Content-Type**: application/json
   266   - **Accept**: application/json
   267  
   268  [[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)
   269  
   270  # **StartBuild**
   271  > StartBuildResponse StartBuild(projectId)
   272  
   273  
   274  ### Required Parameters
   275  
   276  Name | Type | Description  | Notes
   277  ------------- | ------------- | ------------- | -------------
   278  **projectId** | **string** | projectId |
   279  
   280  ### Return type
   281  
   282  *[**StartBuildResponse**](StartBuildResponse.md)
   283  
   284  ### Authorization
   285  
   286  [x-ncp-iam](../README.md#x-ncp-iam)
   287  
   288  ### HTTP request headers
   289  
   290   - **Content-Type**: application/json
   291   - **Accept**: application/json
   292  
   293  [[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)
   294  
   295  # **DeleteProject**
   296  > DeleteProject(projectId)
   297  
   298  
   299  ### Required Parameters
   300  
   301  Name | Type | Description  | Notes
   302  ------------- | ------------- | ------------- | -------------
   303  **projectId** | **string** | projectId |
   304  
   305  ### Return type
   306  
   307   (empty response body)
   308  
   309  ### Authorization
   310  
   311  [x-ncp-iam](../README.md#x-ncp-iam)
   312  
   313  ### HTTP request headers
   314  
   315   - **Content-Type**: application/json
   316   - **Accept**: application/json
   317  
   318  [[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)
   319  
   320  # **GetProject**
   321  > GetProjectDetailResponse GetProject(projectId)
   322  
   323  
   324  ### Required Parameters
   325  
   326  Name | Type | Description  | Notes
   327  ------------- | ------------- | ------------- | -------------
   328  **projectId** | **string** | projectId |
   329  
   330  ### Return type
   331  
   332  *[**GetProjectDetailResponse**](GetProjectDetailResponse.md)
   333  
   334  ### Authorization
   335  
   336  [x-ncp-iam](../README.md#x-ncp-iam)
   337  
   338  ### HTTP request headers
   339  
   340   - **Content-Type**: application/json
   341   - **Accept**: application/json
   342  
   343  [[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)
   344  
   345  # **GetBuildHistory**
   346  > GetBuildHistoryResponse GetBuildHistory(projectId)
   347  
   348  
   349  ### Required Parameters
   350  
   351  Name | Type | Description  | Notes
   352  ------------- | ------------- | ------------- | -------------
   353  **projectId** | **string** | projectId |
   354  
   355  ### Return type
   356  
   357  *[**GetBuildHistoryResponse**](GetBuildHistoryResponse.md)
   358  
   359  ### Authorization
   360  
   361  [x-ncp-iam](../README.md#x-ncp-iam)
   362  
   363  ### HTTP request headers
   364  
   365   - **Content-Type**: application/json
   366   - **Accept**: application/json
   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  # **ChangeProject**
   371  > CreateProjectResponse ChangeProject(body, projectId)
   372  
   373  
   374  ### Required Parameters
   375  
   376  Name | Type | Description  | Notes
   377  ------------- | ------------- | ------------- | -------------
   378  **body** | **[\*ChangeProject](ChangeProject.md)** |  | **projectId** | **string** | projectId |
   379  
   380  ### Return type
   381  
   382  *[**CreateProjectResponse**](CreateProjectResponse.md)
   383  
   384  ### Authorization
   385  
   386  [x-ncp-iam](../README.md#x-ncp-iam)
   387  
   388  ### HTTP request headers
   389  
   390   - **Content-Type**: application/json
   391   - **Accept**: application/json
   392  
   393  [[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)
   394  
   395  # **GetSourcecommitRepositories**
   396  > GetScRepositoryResponse GetSourcecommitRepositories()
   397  
   398  
   399  ### Required Parameters
   400  
   401  This endpoint does not need any parameter.
   402  
   403  ### Return type
   404  
   405  *[**GetScRepositoryResponse**](GetScRepositoryResponse.md)
   406  
   407  ### Authorization
   408  
   409  [x-ncp-iam](../README.md#x-ncp-iam)
   410  
   411  ### HTTP request headers
   412  
   413   - **Content-Type**: application/json
   414   - **Accept**: application/json
   415  
   416  [[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)
   417  
   418  # **GetSourcecommitRepositoryBranches**
   419  > GetScBranchResponse GetSourcecommitRepositoryBranches(repositoryName)
   420  
   421  
   422  ### Required Parameters
   423  
   424  Name | Type | Description  | Notes
   425  ------------- | ------------- | ------------- | -------------
   426  **repositoryName** | **string** | repositoryName | 
   427  
   428  ### Return type
   429  
   430  *[**GetScBranchResponse**](GetScBranchResponse.md)
   431  
   432  ### Authorization
   433  
   434  [x-ncp-iam](../README.md#x-ncp-iam)
   435  
   436  ### HTTP request headers
   437  
   438   - **Content-Type**: application/json
   439   - **Accept**: application/json
   440  
   441  [[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)
   442