github.com/spinnaker/spin@v1.30.0/gateapi/docs/PipelineControllerApi.md (about)

     1  # \PipelineControllerApi
     2  
     3  All URIs are relative to *https://localhost*
     4  
     5  Method | HTTP request | Description
     6  ------------- | ------------- | -------------
     7  [**CancelPipelineUsingPUT1**](PipelineControllerApi.md#CancelPipelineUsingPUT1) | **Put** /pipelines/{id}/cancel | Cancel a pipeline execution
     8  [**DeletePipelineUsingDELETE**](PipelineControllerApi.md#DeletePipelineUsingDELETE) | **Delete** /pipelines/{application}/{pipelineName} | Delete a pipeline definition
     9  [**DeletePipelineUsingDELETE1**](PipelineControllerApi.md#DeletePipelineUsingDELETE1) | **Delete** /pipelines/{id} | Delete a pipeline execution
    10  [**EvaluateExpressionForExecutionAtStageUsingGET**](PipelineControllerApi.md#EvaluateExpressionForExecutionAtStageUsingGET) | **Get** /pipelines/{id}/{stageId}/evaluateExpression | Evaluate a pipeline expression at a specific stage using the provided execution as context
    11  [**EvaluateExpressionForExecutionUsingGET**](PipelineControllerApi.md#EvaluateExpressionForExecutionUsingGET) | **Get** /pipelines/{id}/evaluateExpression | Evaluate a pipeline expression using the provided execution as context
    12  [**EvaluateExpressionForExecutionViaPOSTUsingPOST1**](PipelineControllerApi.md#EvaluateExpressionForExecutionViaPOSTUsingPOST1) | **Post** /pipelines/{id}/evaluateExpression | Evaluate a pipeline expression using the provided execution as context
    13  [**EvaluateVariablesUsingPOST**](PipelineControllerApi.md#EvaluateVariablesUsingPOST) | **Post** /pipelines/{id}/evaluateVariables | Evaluate variables same as Evaluate Variables stage using the provided execution as context
    14  [**GetPipelineUsingGET**](PipelineControllerApi.md#GetPipelineUsingGET) | **Get** /pipelines/{id} | Retrieve a pipeline execution
    15  [**InvokePipelineConfigUsingPOST1**](PipelineControllerApi.md#InvokePipelineConfigUsingPOST1) | **Post** /pipelines/{application}/{pipelineNameOrId} | Trigger a pipeline execution
    16  [**InvokePipelineConfigViaEchoUsingPOST**](PipelineControllerApi.md#InvokePipelineConfigViaEchoUsingPOST) | **Post** /pipelines/v2/{application}/{pipelineNameOrId} | Trigger a pipeline execution
    17  [**PausePipelineUsingPUT**](PipelineControllerApi.md#PausePipelineUsingPUT) | **Put** /pipelines/{id}/pause | Pause a pipeline execution
    18  [**RenamePipelineUsingPOST**](PipelineControllerApi.md#RenamePipelineUsingPOST) | **Post** /pipelines/move | Rename a pipeline definition
    19  [**RestartStageUsingPUT**](PipelineControllerApi.md#RestartStageUsingPUT) | **Put** /pipelines/{id}/stages/{stageId}/restart | Restart a stage execution
    20  [**ResumePipelineUsingPUT**](PipelineControllerApi.md#ResumePipelineUsingPUT) | **Put** /pipelines/{id}/resume | Resume a pipeline execution
    21  [**SavePipelineUsingPOST**](PipelineControllerApi.md#SavePipelineUsingPOST) | **Post** /pipelines | Save a pipeline definition
    22  [**StartUsingPOST**](PipelineControllerApi.md#StartUsingPOST) | **Post** /pipelines/start | Initiate a pipeline execution
    23  [**UpdatePipelineUsingPUT**](PipelineControllerApi.md#UpdatePipelineUsingPUT) | **Put** /pipelines/{id} | Update a pipeline definition
    24  [**UpdateStageUsingPATCH**](PipelineControllerApi.md#UpdateStageUsingPATCH) | **Patch** /pipelines/{id}/stages/{stageId} | Update a stage execution
    25  
    26  
    27  # **CancelPipelineUsingPUT1**
    28  > CancelPipelineUsingPUT1(ctx, id, optional)
    29  Cancel a pipeline execution
    30  
    31  ### Required Parameters
    32  
    33  Name | Type | Description  | Notes
    34  ------------- | ------------- | ------------- | -------------
    35   **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
    36    **id** | **string**| id | 
    37   **optional** | ***PipelineControllerApiCancelPipelineUsingPUT1Opts** | optional parameters | nil if no parameters
    38  
    39  ### Optional Parameters
    40  Optional parameters are passed through a pointer to a PipelineControllerApiCancelPipelineUsingPUT1Opts struct
    41  
    42  Name | Type | Description  | Notes
    43  ------------- | ------------- | ------------- | -------------
    44  
    45   **force** | **optional.Bool**| force | [default to false]
    46   **reason** | **optional.String**| reason | 
    47  
    48  ### Return type
    49  
    50   (empty response body)
    51  
    52  ### Authorization
    53  
    54  No authorization required
    55  
    56  ### HTTP request headers
    57  
    58   - **Content-Type**: application/json
    59   - **Accept**: */*
    60  
    61  [[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)
    62  
    63  # **DeletePipelineUsingDELETE**
    64  > DeletePipelineUsingDELETE(ctx, application, pipelineName)
    65  Delete a pipeline definition
    66  
    67  ### Required Parameters
    68  
    69  Name | Type | Description  | Notes
    70  ------------- | ------------- | ------------- | -------------
    71   **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
    72    **application** | **string**| application | 
    73    **pipelineName** | **string**| pipelineName | 
    74  
    75  ### Return type
    76  
    77   (empty response body)
    78  
    79  ### Authorization
    80  
    81  No authorization required
    82  
    83  ### HTTP request headers
    84  
    85   - **Content-Type**: Not defined
    86   - **Accept**: */*
    87  
    88  [[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)
    89  
    90  # **DeletePipelineUsingDELETE1**
    91  > map[string]interface{} DeletePipelineUsingDELETE1(ctx, id)
    92  Delete a pipeline execution
    93  
    94  ### Required Parameters
    95  
    96  Name | Type | Description  | Notes
    97  ------------- | ------------- | ------------- | -------------
    98   **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
    99    **id** | **string**| id | 
   100  
   101  ### Return type
   102  
   103  [**map[string]interface{}**](interface{}.md)
   104  
   105  ### Authorization
   106  
   107  No authorization required
   108  
   109  ### HTTP request headers
   110  
   111   - **Content-Type**: Not defined
   112   - **Accept**: */*
   113  
   114  [[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)
   115  
   116  # **EvaluateExpressionForExecutionAtStageUsingGET**
   117  > map[string]interface{} EvaluateExpressionForExecutionAtStageUsingGET(ctx, expression, id, stageId)
   118  Evaluate a pipeline expression at a specific stage using the provided execution as context
   119  
   120  ### Required Parameters
   121  
   122  Name | Type | Description  | Notes
   123  ------------- | ------------- | ------------- | -------------
   124   **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
   125    **expression** | **string**| expression | 
   126    **id** | **string**| id | 
   127    **stageId** | **string**| stageId | 
   128  
   129  ### Return type
   130  
   131  [**map[string]interface{}**](interface{}.md)
   132  
   133  ### Authorization
   134  
   135  No authorization required
   136  
   137  ### HTTP request headers
   138  
   139   - **Content-Type**: Not defined
   140   - **Accept**: */*
   141  
   142  [[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)
   143  
   144  # **EvaluateExpressionForExecutionUsingGET**
   145  > map[string]interface{} EvaluateExpressionForExecutionUsingGET(ctx, expression, id)
   146  Evaluate a pipeline expression using the provided execution as context
   147  
   148  ### Required Parameters
   149  
   150  Name | Type | Description  | Notes
   151  ------------- | ------------- | ------------- | -------------
   152   **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
   153    **expression** | **string**| expression | 
   154    **id** | **string**| id | 
   155  
   156  ### Return type
   157  
   158  [**map[string]interface{}**](interface{}.md)
   159  
   160  ### Authorization
   161  
   162  No authorization required
   163  
   164  ### HTTP request headers
   165  
   166   - **Content-Type**: Not defined
   167   - **Accept**: */*
   168  
   169  [[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)
   170  
   171  # **EvaluateExpressionForExecutionViaPOSTUsingPOST1**
   172  > map[string]interface{} EvaluateExpressionForExecutionViaPOSTUsingPOST1(ctx, id, pipelineExpression)
   173  Evaluate a pipeline expression using the provided execution as context
   174  
   175  ### Required Parameters
   176  
   177  Name | Type | Description  | Notes
   178  ------------- | ------------- | ------------- | -------------
   179   **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
   180    **id** | **string**| id | 
   181    **pipelineExpression** | [**interface{}**](interface{}.md)| pipelineExpression | 
   182  
   183  ### Return type
   184  
   185  [**map[string]interface{}**](interface{}.md)
   186  
   187  ### Authorization
   188  
   189  No authorization required
   190  
   191  ### HTTP request headers
   192  
   193   - **Content-Type**: application/json
   194   - **Accept**: */*
   195  
   196  [[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)
   197  
   198  # **EvaluateVariablesUsingPOST**
   199  > map[string]interface{} EvaluateVariablesUsingPOST(ctx, executionId, expressions, optional)
   200  Evaluate variables same as Evaluate Variables stage using the provided execution as context
   201  
   202  ### Required Parameters
   203  
   204  Name | Type | Description  | Notes
   205  ------------- | ------------- | ------------- | -------------
   206   **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
   207    **executionId** | **string**| Execution id to run against | 
   208    **expressions** | [**[]Mapstringstring**](Map«string,string».md)| List of variables/expressions to evaluate | 
   209   **optional** | ***PipelineControllerApiEvaluateVariablesUsingPOSTOpts** | optional parameters | nil if no parameters
   210  
   211  ### Optional Parameters
   212  Optional parameters are passed through a pointer to a PipelineControllerApiEvaluateVariablesUsingPOSTOpts struct
   213  
   214  Name | Type | Description  | Notes
   215  ------------- | ------------- | ------------- | -------------
   216  
   217  
   218   **requisiteStageRefIds** | **optional.String**| Comma separated list of requisite stage IDs for the evaluation stage | 
   219   **spelVersion** | **optional.String**| Version of SpEL evaluation logic to use (v3 or v4) | 
   220  
   221  ### Return type
   222  
   223  [**map[string]interface{}**](interface{}.md)
   224  
   225  ### Authorization
   226  
   227  No authorization required
   228  
   229  ### HTTP request headers
   230  
   231   - **Content-Type**: application/json
   232   - **Accept**: */*
   233  
   234  [[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)
   235  
   236  # **GetPipelineUsingGET**
   237  > interface{} GetPipelineUsingGET(ctx, id)
   238  Retrieve a pipeline execution
   239  
   240  ### Required Parameters
   241  
   242  Name | Type | Description  | Notes
   243  ------------- | ------------- | ------------- | -------------
   244   **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
   245    **id** | **string**| id | 
   246  
   247  ### Return type
   248  
   249  [**interface{}**](interface{}.md)
   250  
   251  ### Authorization
   252  
   253  No authorization required
   254  
   255  ### HTTP request headers
   256  
   257   - **Content-Type**: Not defined
   258   - **Accept**: */*
   259  
   260  [[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)
   261  
   262  # **InvokePipelineConfigUsingPOST1**
   263  > InvokePipelineConfigUsingPOST1(ctx, application, pipelineNameOrId, optional)
   264  Trigger a pipeline execution
   265  
   266  ### Required Parameters
   267  
   268  Name | Type | Description  | Notes
   269  ------------- | ------------- | ------------- | -------------
   270   **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
   271    **application** | **string**| application | 
   272    **pipelineNameOrId** | **string**| pipelineNameOrId | 
   273   **optional** | ***PipelineControllerApiInvokePipelineConfigUsingPOST1Opts** | optional parameters | nil if no parameters
   274  
   275  ### Optional Parameters
   276  Optional parameters are passed through a pointer to a PipelineControllerApiInvokePipelineConfigUsingPOST1Opts struct
   277  
   278  Name | Type | Description  | Notes
   279  ------------- | ------------- | ------------- | -------------
   280  
   281  
   282   **trigger** | [**optional.Interface of interface{}**](interface{}.md)| trigger | 
   283  
   284  ### Return type
   285  
   286   (empty response body)
   287  
   288  ### Authorization
   289  
   290  No authorization required
   291  
   292  ### HTTP request headers
   293  
   294   - **Content-Type**: application/json
   295   - **Accept**: */*
   296  
   297  [[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)
   298  
   299  # **InvokePipelineConfigViaEchoUsingPOST**
   300  > interface{} InvokePipelineConfigViaEchoUsingPOST(ctx, application, pipelineNameOrId, optional)
   301  Trigger a pipeline execution
   302  
   303  ### Required Parameters
   304  
   305  Name | Type | Description  | Notes
   306  ------------- | ------------- | ------------- | -------------
   307   **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
   308    **application** | **string**| application | 
   309    **pipelineNameOrId** | **string**| pipelineNameOrId | 
   310   **optional** | ***PipelineControllerApiInvokePipelineConfigViaEchoUsingPOSTOpts** | optional parameters | nil if no parameters
   311  
   312  ### Optional Parameters
   313  Optional parameters are passed through a pointer to a PipelineControllerApiInvokePipelineConfigViaEchoUsingPOSTOpts struct
   314  
   315  Name | Type | Description  | Notes
   316  ------------- | ------------- | ------------- | -------------
   317  
   318  
   319   **trigger** | [**optional.Interface of interface{}**](interface{}.md)| trigger | 
   320  
   321  ### Return type
   322  
   323  [**interface{}**](interface{}.md)
   324  
   325  ### Authorization
   326  
   327  No authorization required
   328  
   329  ### HTTP request headers
   330  
   331   - **Content-Type**: application/json
   332   - **Accept**: */*
   333  
   334  [[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)
   335  
   336  # **PausePipelineUsingPUT**
   337  > PausePipelineUsingPUT(ctx, id)
   338  Pause a pipeline execution
   339  
   340  ### Required Parameters
   341  
   342  Name | Type | Description  | Notes
   343  ------------- | ------------- | ------------- | -------------
   344   **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
   345    **id** | **string**| id | 
   346  
   347  ### Return type
   348  
   349   (empty response body)
   350  
   351  ### Authorization
   352  
   353  No authorization required
   354  
   355  ### HTTP request headers
   356  
   357   - **Content-Type**: application/json
   358   - **Accept**: */*
   359  
   360  [[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)
   361  
   362  # **RenamePipelineUsingPOST**
   363  > RenamePipelineUsingPOST(ctx, renameCommand)
   364  Rename a pipeline definition
   365  
   366  ### Required Parameters
   367  
   368  Name | Type | Description  | Notes
   369  ------------- | ------------- | ------------- | -------------
   370   **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
   371    **renameCommand** | [**interface{}**](interface{}.md)| renameCommand | 
   372  
   373  ### Return type
   374  
   375   (empty response body)
   376  
   377  ### Authorization
   378  
   379  No authorization required
   380  
   381  ### HTTP request headers
   382  
   383   - **Content-Type**: application/json
   384   - **Accept**: */*
   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)
   387  
   388  # **RestartStageUsingPUT**
   389  > map[string]interface{} RestartStageUsingPUT(ctx, context, id, stageId)
   390  Restart a stage execution
   391  
   392  ### Required Parameters
   393  
   394  Name | Type | Description  | Notes
   395  ------------- | ------------- | ------------- | -------------
   396   **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
   397    **context** | [**interface{}**](interface{}.md)| context | 
   398    **id** | **string**| id | 
   399    **stageId** | **string**| stageId | 
   400  
   401  ### Return type
   402  
   403  [**map[string]interface{}**](interface{}.md)
   404  
   405  ### Authorization
   406  
   407  No authorization required
   408  
   409  ### HTTP request headers
   410  
   411   - **Content-Type**: application/json
   412   - **Accept**: */*
   413  
   414  [[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)
   415  
   416  # **ResumePipelineUsingPUT**
   417  > map[string]interface{} ResumePipelineUsingPUT(ctx, id)
   418  Resume a pipeline execution
   419  
   420  ### Required Parameters
   421  
   422  Name | Type | Description  | Notes
   423  ------------- | ------------- | ------------- | -------------
   424   **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
   425    **id** | **string**| id | 
   426  
   427  ### Return type
   428  
   429  [**map[string]interface{}**](interface{}.md)
   430  
   431  ### Authorization
   432  
   433  No authorization required
   434  
   435  ### HTTP request headers
   436  
   437   - **Content-Type**: application/json
   438   - **Accept**: */*
   439  
   440  [[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)
   441  
   442  # **SavePipelineUsingPOST**
   443  > SavePipelineUsingPOST(ctx, pipeline, optional)
   444  Save a pipeline definition
   445  
   446  ### Required Parameters
   447  
   448  Name | Type | Description  | Notes
   449  ------------- | ------------- | ------------- | -------------
   450   **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
   451    **pipeline** | [**interface{}**](interface{}.md)| pipeline | 
   452   **optional** | ***PipelineControllerApiSavePipelineUsingPOSTOpts** | optional parameters | nil if no parameters
   453  
   454  ### Optional Parameters
   455  Optional parameters are passed through a pointer to a PipelineControllerApiSavePipelineUsingPOSTOpts struct
   456  
   457  Name | Type | Description  | Notes
   458  ------------- | ------------- | ------------- | -------------
   459  
   460   **staleCheck** | **optional.Bool**| staleCheck | [default to false]
   461  
   462  ### Return type
   463  
   464   (empty response body)
   465  
   466  ### Authorization
   467  
   468  No authorization required
   469  
   470  ### HTTP request headers
   471  
   472   - **Content-Type**: application/json
   473   - **Accept**: */*
   474  
   475  [[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)
   476  
   477  # **StartUsingPOST**
   478  > ResponseEntity StartUsingPOST(ctx, map_)
   479  Initiate a pipeline execution
   480  
   481  ### Required Parameters
   482  
   483  Name | Type | Description  | Notes
   484  ------------- | ------------- | ------------- | -------------
   485   **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
   486    **map_** | [**interface{}**](interface{}.md)| map | 
   487  
   488  ### Return type
   489  
   490  [**ResponseEntity**](ResponseEntity.md)
   491  
   492  ### Authorization
   493  
   494  No authorization required
   495  
   496  ### HTTP request headers
   497  
   498   - **Content-Type**: application/json
   499   - **Accept**: */*
   500  
   501  [[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)
   502  
   503  # **UpdatePipelineUsingPUT**
   504  > map[string]interface{} UpdatePipelineUsingPUT(ctx, id, pipeline)
   505  Update a pipeline definition
   506  
   507  ### Required Parameters
   508  
   509  Name | Type | Description  | Notes
   510  ------------- | ------------- | ------------- | -------------
   511   **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
   512    **id** | **string**| id | 
   513    **pipeline** | [**interface{}**](interface{}.md)| pipeline | 
   514  
   515  ### Return type
   516  
   517  [**map[string]interface{}**](interface{}.md)
   518  
   519  ### Authorization
   520  
   521  No authorization required
   522  
   523  ### HTTP request headers
   524  
   525   - **Content-Type**: application/json
   526   - **Accept**: */*
   527  
   528  [[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)
   529  
   530  # **UpdateStageUsingPATCH**
   531  > map[string]interface{} UpdateStageUsingPATCH(ctx, context, id, stageId)
   532  Update a stage execution
   533  
   534  ### Required Parameters
   535  
   536  Name | Type | Description  | Notes
   537  ------------- | ------------- | ------------- | -------------
   538   **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
   539    **context** | [**interface{}**](interface{}.md)| context | 
   540    **id** | **string**| id | 
   541    **stageId** | **string**| stageId | 
   542  
   543  ### Return type
   544  
   545  [**map[string]interface{}**](interface{}.md)
   546  
   547  ### Authorization
   548  
   549  No authorization required
   550  
   551  ### HTTP request headers
   552  
   553   - **Content-Type**: application/json
   554   - **Accept**: */*
   555  
   556  [[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)
   557