github.com/spinnaker/spin@v1.30.0/gateapi/docs/V2PipelineTemplatesControllerApi.md (about) 1 # \V2PipelineTemplatesControllerApi 2 3 All URIs are relative to *https://localhost* 4 5 Method | HTTP request | Description 6 ------------- | ------------- | ------------- 7 [**CreateUsingPOST1**](V2PipelineTemplatesControllerApi.md#CreateUsingPOST1) | **Post** /v2/pipelineTemplates/create | (ALPHA) Create a pipeline template. 8 [**DeleteUsingDELETE1**](V2PipelineTemplatesControllerApi.md#DeleteUsingDELETE1) | **Delete** /v2/pipelineTemplates/{id} | Delete a pipeline template. 9 [**GetUsingGET2**](V2PipelineTemplatesControllerApi.md#GetUsingGET2) | **Get** /v2/pipelineTemplates/{id} | (ALPHA) Get a pipeline template. 10 [**ListPipelineTemplateDependentsUsingGET1**](V2PipelineTemplatesControllerApi.md#ListPipelineTemplateDependentsUsingGET1) | **Get** /v2/pipelineTemplates/{id}/dependents | (ALPHA) List all pipelines that implement a pipeline template 11 [**ListUsingGET1**](V2PipelineTemplatesControllerApi.md#ListUsingGET1) | **Get** /v2/pipelineTemplates | (ALPHA) List pipeline templates. 12 [**ListVersionsUsingGET**](V2PipelineTemplatesControllerApi.md#ListVersionsUsingGET) | **Get** /v2/pipelineTemplates/versions | List pipeline templates with versions 13 [**PlanUsingPOST**](V2PipelineTemplatesControllerApi.md#PlanUsingPOST) | **Post** /v2/pipelineTemplates/plan | (ALPHA) Plan a pipeline template configuration. 14 [**UpdateUsingPOST1**](V2PipelineTemplatesControllerApi.md#UpdateUsingPOST1) | **Post** /v2/pipelineTemplates/update/{id} | (ALPHA) Update a pipeline template. 15 16 17 # **CreateUsingPOST1** 18 > map[string]interface{} CreateUsingPOST1(ctx, pipelineTemplate, optional) 19 (ALPHA) Create a pipeline template. 20 21 ### Required Parameters 22 23 Name | Type | Description | Notes 24 ------------- | ------------- | ------------- | ------------- 25 **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. 26 **pipelineTemplate** | [**interface{}**](interface{}.md)| pipelineTemplate | 27 **optional** | ***V2PipelineTemplatesControllerApiCreateUsingPOST1Opts** | optional parameters | nil if no parameters 28 29 ### Optional Parameters 30 Optional parameters are passed through a pointer to a V2PipelineTemplatesControllerApiCreateUsingPOST1Opts struct 31 32 Name | Type | Description | Notes 33 ------------- | ------------- | ------------- | ------------- 34 35 **tag** | **optional.String**| tag | 36 37 ### Return type 38 39 [**map[string]interface{}**](interface{}.md) 40 41 ### Authorization 42 43 No authorization required 44 45 ### HTTP request headers 46 47 - **Content-Type**: application/json 48 - **Accept**: */* 49 50 [[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) 51 52 # **DeleteUsingDELETE1** 53 > map[string]interface{} DeleteUsingDELETE1(ctx, id, optional) 54 Delete a pipeline template. 55 56 ### Required Parameters 57 58 Name | Type | Description | Notes 59 ------------- | ------------- | ------------- | ------------- 60 **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. 61 **id** | **string**| id | 62 **optional** | ***V2PipelineTemplatesControllerApiDeleteUsingDELETE1Opts** | optional parameters | nil if no parameters 63 64 ### Optional Parameters 65 Optional parameters are passed through a pointer to a V2PipelineTemplatesControllerApiDeleteUsingDELETE1Opts struct 66 67 Name | Type | Description | Notes 68 ------------- | ------------- | ------------- | ------------- 69 70 **application** | **optional.String**| application | 71 **digest** | **optional.String**| digest | 72 **tag** | **optional.String**| tag | 73 74 ### Return type 75 76 [**map[string]interface{}**](interface{}.md) 77 78 ### Authorization 79 80 No authorization required 81 82 ### HTTP request headers 83 84 - **Content-Type**: Not defined 85 - **Accept**: */* 86 87 [[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) 88 89 # **GetUsingGET2** 90 > map[string]interface{} GetUsingGET2(ctx, id, optional) 91 (ALPHA) Get a pipeline template. 92 93 ### Required Parameters 94 95 Name | Type | Description | Notes 96 ------------- | ------------- | ------------- | ------------- 97 **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. 98 **id** | **string**| id | 99 **optional** | ***V2PipelineTemplatesControllerApiGetUsingGET2Opts** | optional parameters | nil if no parameters 100 101 ### Optional Parameters 102 Optional parameters are passed through a pointer to a V2PipelineTemplatesControllerApiGetUsingGET2Opts struct 103 104 Name | Type | Description | Notes 105 ------------- | ------------- | ------------- | ------------- 106 107 **digest** | **optional.String**| digest | 108 **tag** | **optional.String**| tag | 109 110 ### Return type 111 112 [**map[string]interface{}**](interface{}.md) 113 114 ### Authorization 115 116 No authorization required 117 118 ### HTTP request headers 119 120 - **Content-Type**: Not defined 121 - **Accept**: */* 122 123 [[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) 124 125 # **ListPipelineTemplateDependentsUsingGET1** 126 > []interface{} ListPipelineTemplateDependentsUsingGET1(ctx, id) 127 (ALPHA) List all pipelines that implement a pipeline template 128 129 ### Required Parameters 130 131 Name | Type | Description | Notes 132 ------------- | ------------- | ------------- | ------------- 133 **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. 134 **id** | **string**| id | 135 136 ### Return type 137 138 [**[]interface{}**](interface{}.md) 139 140 ### Authorization 141 142 No authorization required 143 144 ### HTTP request headers 145 146 - **Content-Type**: Not defined 147 - **Accept**: */* 148 149 [[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) 150 151 # **ListUsingGET1** 152 > []interface{} ListUsingGET1(ctx, optional) 153 (ALPHA) List pipeline templates. 154 155 ### Required Parameters 156 157 Name | Type | Description | Notes 158 ------------- | ------------- | ------------- | ------------- 159 **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. 160 **optional** | ***V2PipelineTemplatesControllerApiListUsingGET1Opts** | optional parameters | nil if no parameters 161 162 ### Optional Parameters 163 Optional parameters are passed through a pointer to a V2PipelineTemplatesControllerApiListUsingGET1Opts struct 164 165 Name | Type | Description | Notes 166 ------------- | ------------- | ------------- | ------------- 167 **scopes** | [**optional.Interface of []string**](string.md)| scopes | 168 169 ### Return type 170 171 [**[]interface{}**](interface{}.md) 172 173 ### Authorization 174 175 No authorization required 176 177 ### HTTP request headers 178 179 - **Content-Type**: Not defined 180 - **Accept**: */* 181 182 [[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) 183 184 # **ListVersionsUsingGET** 185 > interface{} ListVersionsUsingGET(ctx, optional) 186 List pipeline templates with versions 187 188 ### Required Parameters 189 190 Name | Type | Description | Notes 191 ------------- | ------------- | ------------- | ------------- 192 **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. 193 **optional** | ***V2PipelineTemplatesControllerApiListVersionsUsingGETOpts** | optional parameters | nil if no parameters 194 195 ### Optional Parameters 196 Optional parameters are passed through a pointer to a V2PipelineTemplatesControllerApiListVersionsUsingGETOpts struct 197 198 Name | Type | Description | Notes 199 ------------- | ------------- | ------------- | ------------- 200 **scopes** | [**optional.Interface of []string**](string.md)| scopes | 201 202 ### Return type 203 204 [**interface{}**](interface{}.md) 205 206 ### Authorization 207 208 No authorization required 209 210 ### HTTP request headers 211 212 - **Content-Type**: Not defined 213 - **Accept**: */* 214 215 [[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) 216 217 # **PlanUsingPOST** 218 > map[string]interface{} PlanUsingPOST(ctx, pipeline) 219 (ALPHA) Plan a pipeline template configuration. 220 221 ### Required Parameters 222 223 Name | Type | Description | Notes 224 ------------- | ------------- | ------------- | ------------- 225 **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. 226 **pipeline** | [**interface{}**](interface{}.md)| pipeline | 227 228 ### Return type 229 230 [**map[string]interface{}**](interface{}.md) 231 232 ### Authorization 233 234 No authorization required 235 236 ### HTTP request headers 237 238 - **Content-Type**: application/json 239 - **Accept**: */* 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 # **UpdateUsingPOST1** 244 > map[string]interface{} UpdateUsingPOST1(ctx, id, pipelineTemplate, optional) 245 (ALPHA) Update a pipeline template. 246 247 ### Required Parameters 248 249 Name | Type | Description | Notes 250 ------------- | ------------- | ------------- | ------------- 251 **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. 252 **id** | **string**| id | 253 **pipelineTemplate** | [**interface{}**](interface{}.md)| pipelineTemplate | 254 **optional** | ***V2PipelineTemplatesControllerApiUpdateUsingPOST1Opts** | optional parameters | nil if no parameters 255 256 ### Optional Parameters 257 Optional parameters are passed through a pointer to a V2PipelineTemplatesControllerApiUpdateUsingPOST1Opts struct 258 259 Name | Type | Description | Notes 260 ------------- | ------------- | ------------- | ------------- 261 262 263 **skipPlanDependents** | **optional.Bool**| skipPlanDependents | [default to false] 264 **tag** | **optional.String**| tag | 265 266 ### Return type 267 268 [**map[string]interface{}**](interface{}.md) 269 270 ### Authorization 271 272 No authorization required 273 274 ### HTTP request headers 275 276 - **Content-Type**: application/json 277 - **Accept**: */* 278 279 [[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) 280