github.com/spinnaker/spin@v1.30.0/gateapi/docs/ApplicationControllerApi.md (about) 1 # \ApplicationControllerApi 2 3 All URIs are relative to *https://localhost* 4 5 Method | HTTP request | Description 6 ------------- | ------------- | ------------- 7 [**CancelPipelineUsingPUT**](ApplicationControllerApi.md#CancelPipelineUsingPUT) | **Put** /applications/{application}/pipelines/{id}/cancel | Cancel pipeline 8 [**CancelTaskUsingPUT**](ApplicationControllerApi.md#CancelTaskUsingPUT) | **Put** /applications/{application}/tasks/{id}/cancel | Cancel task 9 [**GetAllApplicationsUsingGET**](ApplicationControllerApi.md#GetAllApplicationsUsingGET) | **Get** /applications | Retrieve a list of applications 10 [**GetApplicationHistoryUsingGET**](ApplicationControllerApi.md#GetApplicationHistoryUsingGET) | **Get** /applications/{application}/history | Retrieve a list of an application's configuration revision history 11 [**GetApplicationUsingGET**](ApplicationControllerApi.md#GetApplicationUsingGET) | **Get** /applications/{application} | Retrieve an application's details 12 [**GetPipelineConfigUsingGET**](ApplicationControllerApi.md#GetPipelineConfigUsingGET) | **Get** /applications/{application}/pipelineConfigs/{pipelineName} | Retrieve a pipeline configuration 13 [**GetPipelineConfigsForApplicationUsingGET**](ApplicationControllerApi.md#GetPipelineConfigsForApplicationUsingGET) | **Get** /applications/{application}/pipelineConfigs | Retrieve a list of an application's pipeline configurations 14 [**GetPipelinesUsingGET**](ApplicationControllerApi.md#GetPipelinesUsingGET) | **Get** /applications/{application}/pipelines | Retrieve a list of an application's pipeline executions 15 [**GetStrategyConfigUsingGET**](ApplicationControllerApi.md#GetStrategyConfigUsingGET) | **Get** /applications/{application}/strategyConfigs/{strategyName} | Retrieve a pipeline strategy configuration 16 [**GetStrategyConfigsForApplicationUsingGET**](ApplicationControllerApi.md#GetStrategyConfigsForApplicationUsingGET) | **Get** /applications/{application}/strategyConfigs | Retrieve a list of an application's pipeline strategy configurations 17 [**GetTaskDetailsUsingGET**](ApplicationControllerApi.md#GetTaskDetailsUsingGET) | **Get** /applications/{application}/tasks/{id}/details/{taskDetailsId} | Get task details 18 [**GetTaskUsingGET**](ApplicationControllerApi.md#GetTaskUsingGET) | **Get** /applications/{application}/tasks/{id} | Get task 19 [**GetTasksUsingGET**](ApplicationControllerApi.md#GetTasksUsingGET) | **Get** /applications/{application}/tasks | Retrieve a list of an application's tasks 20 [**InvokePipelineConfigUsingPOST**](ApplicationControllerApi.md#InvokePipelineConfigUsingPOST) | **Post** /applications/{application}/pipelineConfigs/{pipelineName} | Invoke pipeline config 21 [**TaskUsingPOST**](ApplicationControllerApi.md#TaskUsingPOST) | **Post** /applications/{application}/tasks | Create task 22 23 24 # **CancelPipelineUsingPUT** 25 > map[string]interface{} CancelPipelineUsingPUT(ctx, id, optional) 26 Cancel pipeline 27 28 ### Required Parameters 29 30 Name | Type | Description | Notes 31 ------------- | ------------- | ------------- | ------------- 32 **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. 33 **id** | **string**| id | 34 **optional** | ***ApplicationControllerApiCancelPipelineUsingPUTOpts** | optional parameters | nil if no parameters 35 36 ### Optional Parameters 37 Optional parameters are passed through a pointer to a ApplicationControllerApiCancelPipelineUsingPUTOpts struct 38 39 Name | Type | Description | Notes 40 ------------- | ------------- | ------------- | ------------- 41 42 **reason** | **optional.String**| reason | 43 44 ### Return type 45 46 [**map[string]interface{}**](interface{}.md) 47 48 ### Authorization 49 50 No authorization required 51 52 ### HTTP request headers 53 54 - **Content-Type**: application/json 55 - **Accept**: */* 56 57 [[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) 58 59 # **CancelTaskUsingPUT** 60 > map[string]interface{} CancelTaskUsingPUT(ctx, id) 61 Cancel task 62 63 ### Required Parameters 64 65 Name | Type | Description | Notes 66 ------------- | ------------- | ------------- | ------------- 67 **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. 68 **id** | **string**| id | 69 70 ### Return type 71 72 [**map[string]interface{}**](interface{}.md) 73 74 ### Authorization 75 76 No authorization required 77 78 ### HTTP request headers 79 80 - **Content-Type**: application/json 81 - **Accept**: */* 82 83 [[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) 84 85 # **GetAllApplicationsUsingGET** 86 > []interface{} GetAllApplicationsUsingGET(ctx, optional) 87 Retrieve a list of applications 88 89 ### Required Parameters 90 91 Name | Type | Description | Notes 92 ------------- | ------------- | ------------- | ------------- 93 **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. 94 **optional** | ***ApplicationControllerApiGetAllApplicationsUsingGETOpts** | optional parameters | nil if no parameters 95 96 ### Optional Parameters 97 Optional parameters are passed through a pointer to a ApplicationControllerApiGetAllApplicationsUsingGETOpts struct 98 99 Name | Type | Description | Notes 100 ------------- | ------------- | ------------- | ------------- 101 **account** | **optional.String**| filters results to only include applications deployed in the specified account | 102 **owner** | **optional.String**| filters results to only include applications owned by the specified email | 103 104 ### Return type 105 106 [**[]interface{}**](interface{}.md) 107 108 ### Authorization 109 110 No authorization required 111 112 ### HTTP request headers 113 114 - **Content-Type**: Not defined 115 - **Accept**: */* 116 117 [[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) 118 119 # **GetApplicationHistoryUsingGET** 120 > []interface{} GetApplicationHistoryUsingGET(ctx, application, optional) 121 Retrieve a list of an application's configuration revision history 122 123 ### Required Parameters 124 125 Name | Type | Description | Notes 126 ------------- | ------------- | ------------- | ------------- 127 **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. 128 **application** | **string**| application | 129 **optional** | ***ApplicationControllerApiGetApplicationHistoryUsingGETOpts** | optional parameters | nil if no parameters 130 131 ### Optional Parameters 132 Optional parameters are passed through a pointer to a ApplicationControllerApiGetApplicationHistoryUsingGETOpts struct 133 134 Name | Type | Description | Notes 135 ------------- | ------------- | ------------- | ------------- 136 137 **limit** | **optional.Int32**| limit | [default to 20] 138 139 ### Return type 140 141 [**[]interface{}**](interface{}.md) 142 143 ### Authorization 144 145 No authorization required 146 147 ### HTTP request headers 148 149 - **Content-Type**: Not defined 150 - **Accept**: */* 151 152 [[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) 153 154 # **GetApplicationUsingGET** 155 > map[string]interface{} GetApplicationUsingGET(ctx, application, optional) 156 Retrieve an application's details 157 158 ### Required Parameters 159 160 Name | Type | Description | Notes 161 ------------- | ------------- | ------------- | ------------- 162 **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. 163 **application** | **string**| application | 164 **optional** | ***ApplicationControllerApiGetApplicationUsingGETOpts** | optional parameters | nil if no parameters 165 166 ### Optional Parameters 167 Optional parameters are passed through a pointer to a ApplicationControllerApiGetApplicationUsingGETOpts struct 168 169 Name | Type | Description | Notes 170 ------------- | ------------- | ------------- | ------------- 171 172 **expand** | **optional.Bool**| expand | [default to true] 173 174 ### Return type 175 176 [**map[string]interface{}**](interface{}.md) 177 178 ### Authorization 179 180 No authorization required 181 182 ### HTTP request headers 183 184 - **Content-Type**: Not defined 185 - **Accept**: */* 186 187 [[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) 188 189 # **GetPipelineConfigUsingGET** 190 > map[string]interface{} GetPipelineConfigUsingGET(ctx, application, pipelineName) 191 Retrieve a pipeline configuration 192 193 ### Required Parameters 194 195 Name | Type | Description | Notes 196 ------------- | ------------- | ------------- | ------------- 197 **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. 198 **application** | **string**| application | 199 **pipelineName** | **string**| pipelineName | 200 201 ### Return type 202 203 [**map[string]interface{}**](interface{}.md) 204 205 ### Authorization 206 207 No authorization required 208 209 ### HTTP request headers 210 211 - **Content-Type**: Not defined 212 - **Accept**: */* 213 214 [[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) 215 216 # **GetPipelineConfigsForApplicationUsingGET** 217 > []interface{} GetPipelineConfigsForApplicationUsingGET(ctx, application) 218 Retrieve a list of an application's pipeline configurations 219 220 ### Required Parameters 221 222 Name | Type | Description | Notes 223 ------------- | ------------- | ------------- | ------------- 224 **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. 225 **application** | **string**| application | 226 227 ### Return type 228 229 [**[]interface{}**](interface{}.md) 230 231 ### Authorization 232 233 No authorization required 234 235 ### HTTP request headers 236 237 - **Content-Type**: Not defined 238 - **Accept**: */* 239 240 [[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) 241 242 # **GetPipelinesUsingGET** 243 > []interface{} GetPipelinesUsingGET(ctx, application, optional) 244 Retrieve a list of an application's pipeline executions 245 246 ### Required Parameters 247 248 Name | Type | Description | Notes 249 ------------- | ------------- | ------------- | ------------- 250 **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. 251 **application** | **string**| application | 252 **optional** | ***ApplicationControllerApiGetPipelinesUsingGETOpts** | optional parameters | nil if no parameters 253 254 ### Optional Parameters 255 Optional parameters are passed through a pointer to a ApplicationControllerApiGetPipelinesUsingGETOpts struct 256 257 Name | Type | Description | Notes 258 ------------- | ------------- | ------------- | ------------- 259 260 **expand** | **optional.Bool**| expand | 261 **limit** | **optional.Int32**| limit | 262 **statuses** | **optional.String**| statuses | 263 264 ### Return type 265 266 [**[]interface{}**](interface{}.md) 267 268 ### Authorization 269 270 No authorization required 271 272 ### HTTP request headers 273 274 - **Content-Type**: Not defined 275 - **Accept**: */* 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 # **GetStrategyConfigUsingGET** 280 > map[string]interface{} GetStrategyConfigUsingGET(ctx, application, strategyName) 281 Retrieve a pipeline strategy configuration 282 283 ### Required Parameters 284 285 Name | Type | Description | Notes 286 ------------- | ------------- | ------------- | ------------- 287 **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. 288 **application** | **string**| application | 289 **strategyName** | **string**| strategyName | 290 291 ### Return type 292 293 [**map[string]interface{}**](interface{}.md) 294 295 ### Authorization 296 297 No authorization required 298 299 ### HTTP request headers 300 301 - **Content-Type**: Not defined 302 - **Accept**: */* 303 304 [[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) 305 306 # **GetStrategyConfigsForApplicationUsingGET** 307 > []interface{} GetStrategyConfigsForApplicationUsingGET(ctx, application) 308 Retrieve a list of an application's pipeline strategy configurations 309 310 ### Required Parameters 311 312 Name | Type | Description | Notes 313 ------------- | ------------- | ------------- | ------------- 314 **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. 315 **application** | **string**| application | 316 317 ### Return type 318 319 [**[]interface{}**](interface{}.md) 320 321 ### Authorization 322 323 No authorization required 324 325 ### HTTP request headers 326 327 - **Content-Type**: Not defined 328 - **Accept**: */* 329 330 [[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) 331 332 # **GetTaskDetailsUsingGET** 333 > map[string]interface{} GetTaskDetailsUsingGET(ctx, id, taskDetailsId, optional) 334 Get task details 335 336 ### Required Parameters 337 338 Name | Type | Description | Notes 339 ------------- | ------------- | ------------- | ------------- 340 **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. 341 **id** | **string**| id | 342 **taskDetailsId** | **string**| taskDetailsId | 343 **optional** | ***ApplicationControllerApiGetTaskDetailsUsingGETOpts** | optional parameters | nil if no parameters 344 345 ### Optional Parameters 346 Optional parameters are passed through a pointer to a ApplicationControllerApiGetTaskDetailsUsingGETOpts struct 347 348 Name | Type | Description | Notes 349 ------------- | ------------- | ------------- | ------------- 350 351 352 **xRateLimitApp** | **optional.String**| X-RateLimit-App | 353 354 ### Return type 355 356 [**map[string]interface{}**](interface{}.md) 357 358 ### Authorization 359 360 No authorization required 361 362 ### HTTP request headers 363 364 - **Content-Type**: Not defined 365 - **Accept**: */* 366 367 [[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) 368 369 # **GetTaskUsingGET** 370 > map[string]interface{} GetTaskUsingGET(ctx, id) 371 Get task 372 373 ### Required Parameters 374 375 Name | Type | Description | Notes 376 ------------- | ------------- | ------------- | ------------- 377 **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. 378 **id** | **string**| id | 379 380 ### Return type 381 382 [**map[string]interface{}**](interface{}.md) 383 384 ### Authorization 385 386 No authorization required 387 388 ### HTTP request headers 389 390 - **Content-Type**: Not defined 391 - **Accept**: */* 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 # **GetTasksUsingGET** 396 > []interface{} GetTasksUsingGET(ctx, application, optional) 397 Retrieve a list of an application's tasks 398 399 ### Required Parameters 400 401 Name | Type | Description | Notes 402 ------------- | ------------- | ------------- | ------------- 403 **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. 404 **application** | **string**| application | 405 **optional** | ***ApplicationControllerApiGetTasksUsingGETOpts** | optional parameters | nil if no parameters 406 407 ### Optional Parameters 408 Optional parameters are passed through a pointer to a ApplicationControllerApiGetTasksUsingGETOpts struct 409 410 Name | Type | Description | Notes 411 ------------- | ------------- | ------------- | ------------- 412 413 **limit** | **optional.Int32**| limit | 414 **page** | **optional.Int32**| page | 415 **statuses** | **optional.String**| statuses | 416 417 ### Return type 418 419 [**[]interface{}**](interface{}.md) 420 421 ### Authorization 422 423 No authorization required 424 425 ### HTTP request headers 426 427 - **Content-Type**: Not defined 428 - **Accept**: */* 429 430 [[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) 431 432 # **InvokePipelineConfigUsingPOST** 433 > HttpEntity InvokePipelineConfigUsingPOST(ctx, application, pipelineName, optional) 434 Invoke pipeline config 435 436 ### Required Parameters 437 438 Name | Type | Description | Notes 439 ------------- | ------------- | ------------- | ------------- 440 **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. 441 **application** | **string**| application | 442 **pipelineName** | **string**| pipelineName | 443 **optional** | ***ApplicationControllerApiInvokePipelineConfigUsingPOSTOpts** | optional parameters | nil if no parameters 444 445 ### Optional Parameters 446 Optional parameters are passed through a pointer to a ApplicationControllerApiInvokePipelineConfigUsingPOSTOpts struct 447 448 Name | Type | Description | Notes 449 ------------- | ------------- | ------------- | ------------- 450 451 452 **trigger** | [**optional.Interface of interface{}**](interface{}.md)| trigger | 453 **user** | **optional.String**| user | 454 455 ### Return type 456 457 [**HttpEntity**](HttpEntity.md) 458 459 ### Authorization 460 461 No authorization required 462 463 ### HTTP request headers 464 465 - **Content-Type**: application/json 466 - **Accept**: */* 467 468 [[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) 469 470 # **TaskUsingPOST** 471 > map[string]interface{} TaskUsingPOST(ctx, application, map_) 472 Create task 473 474 ### Required Parameters 475 476 Name | Type | Description | Notes 477 ------------- | ------------- | ------------- | ------------- 478 **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. 479 **application** | **string**| application | 480 **map_** | [**interface{}**](interface{}.md)| map | 481 482 ### Return type 483 484 [**map[string]interface{}**](interface{}.md) 485 486 ### Authorization 487 488 No authorization required 489 490 ### HTTP request headers 491 492 - **Content-Type**: application/json 493 - **Accept**: */* 494 495 [[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) 496