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

     1  # \V2CanaryConfigControllerApi
     2  
     3  All URIs are relative to *https://localhost*
     4  
     5  Method | HTTP request | Description
     6  ------------- | ------------- | -------------
     7  [**CreateCanaryConfigUsingPOST**](V2CanaryConfigControllerApi.md#CreateCanaryConfigUsingPOST) | **Post** /v2/canaryConfig | Create a canary configuration
     8  [**DeleteCanaryConfigUsingDELETE**](V2CanaryConfigControllerApi.md#DeleteCanaryConfigUsingDELETE) | **Delete** /v2/canaryConfig/{id} | Delete a canary configuration
     9  [**GetCanaryConfigUsingGET**](V2CanaryConfigControllerApi.md#GetCanaryConfigUsingGET) | **Get** /v2/canaryConfig/{id} | Retrieve a canary configuration by id
    10  [**GetCanaryConfigsUsingGET**](V2CanaryConfigControllerApi.md#GetCanaryConfigsUsingGET) | **Get** /v2/canaryConfig | Retrieve a list of canary configurations
    11  [**UpdateCanaryConfigUsingPUT**](V2CanaryConfigControllerApi.md#UpdateCanaryConfigUsingPUT) | **Put** /v2/canaryConfig/{id} | Update a canary configuration
    12  
    13  
    14  # **CreateCanaryConfigUsingPOST**
    15  > interface{} CreateCanaryConfigUsingPOST(ctx, config, optional)
    16  Create a canary configuration
    17  
    18  ### Required Parameters
    19  
    20  Name | Type | Description  | Notes
    21  ------------- | ------------- | ------------- | -------------
    22   **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
    23    **config** | [**interface{}**](interface{}.md)| config | 
    24   **optional** | ***V2CanaryConfigControllerApiCreateCanaryConfigUsingPOSTOpts** | optional parameters | nil if no parameters
    25  
    26  ### Optional Parameters
    27  Optional parameters are passed through a pointer to a V2CanaryConfigControllerApiCreateCanaryConfigUsingPOSTOpts struct
    28  
    29  Name | Type | Description  | Notes
    30  ------------- | ------------- | ------------- | -------------
    31  
    32   **configurationAccountName** | **optional.String**| configurationAccountName | 
    33  
    34  ### Return type
    35  
    36  [**interface{}**](interface{}.md)
    37  
    38  ### Authorization
    39  
    40  No authorization required
    41  
    42  ### HTTP request headers
    43  
    44   - **Content-Type**: application/json
    45   - **Accept**: */*
    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  # **DeleteCanaryConfigUsingDELETE**
    50  > DeleteCanaryConfigUsingDELETE(ctx, id, optional)
    51  Delete a canary configuration
    52  
    53  ### Required Parameters
    54  
    55  Name | Type | Description  | Notes
    56  ------------- | ------------- | ------------- | -------------
    57   **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
    58    **id** | **string**| id | 
    59   **optional** | ***V2CanaryConfigControllerApiDeleteCanaryConfigUsingDELETEOpts** | optional parameters | nil if no parameters
    60  
    61  ### Optional Parameters
    62  Optional parameters are passed through a pointer to a V2CanaryConfigControllerApiDeleteCanaryConfigUsingDELETEOpts struct
    63  
    64  Name | Type | Description  | Notes
    65  ------------- | ------------- | ------------- | -------------
    66  
    67   **configurationAccountName** | **optional.String**| configurationAccountName | 
    68  
    69  ### Return type
    70  
    71   (empty response body)
    72  
    73  ### Authorization
    74  
    75  No authorization required
    76  
    77  ### HTTP request headers
    78  
    79   - **Content-Type**: Not defined
    80   - **Accept**: */*
    81  
    82  [[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)
    83  
    84  # **GetCanaryConfigUsingGET**
    85  > interface{} GetCanaryConfigUsingGET(ctx, id, optional)
    86  Retrieve a canary configuration by id
    87  
    88  ### Required Parameters
    89  
    90  Name | Type | Description  | Notes
    91  ------------- | ------------- | ------------- | -------------
    92   **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
    93    **id** | **string**| id | 
    94   **optional** | ***V2CanaryConfigControllerApiGetCanaryConfigUsingGETOpts** | optional parameters | nil if no parameters
    95  
    96  ### Optional Parameters
    97  Optional parameters are passed through a pointer to a V2CanaryConfigControllerApiGetCanaryConfigUsingGETOpts struct
    98  
    99  Name | Type | Description  | Notes
   100  ------------- | ------------- | ------------- | -------------
   101  
   102   **configurationAccountName** | **optional.String**| configurationAccountName | 
   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  # **GetCanaryConfigsUsingGET**
   120  > []interface{} GetCanaryConfigsUsingGET(ctx, optional)
   121  Retrieve a list of canary configurations
   122  
   123  ### Required Parameters
   124  
   125  Name | Type | Description  | Notes
   126  ------------- | ------------- | ------------- | -------------
   127   **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
   128   **optional** | ***V2CanaryConfigControllerApiGetCanaryConfigsUsingGETOpts** | optional parameters | nil if no parameters
   129  
   130  ### Optional Parameters
   131  Optional parameters are passed through a pointer to a V2CanaryConfigControllerApiGetCanaryConfigsUsingGETOpts struct
   132  
   133  Name | Type | Description  | Notes
   134  ------------- | ------------- | ------------- | -------------
   135   **application** | **optional.String**| application | 
   136   **configurationAccountName** | **optional.String**| configurationAccountName | 
   137  
   138  ### Return type
   139  
   140  [**[]interface{}**](interface{}.md)
   141  
   142  ### Authorization
   143  
   144  No authorization required
   145  
   146  ### HTTP request headers
   147  
   148   - **Content-Type**: Not defined
   149   - **Accept**: */*
   150  
   151  [[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)
   152  
   153  # **UpdateCanaryConfigUsingPUT**
   154  > interface{} UpdateCanaryConfigUsingPUT(ctx, config, id, optional)
   155  Update a canary configuration
   156  
   157  ### Required Parameters
   158  
   159  Name | Type | Description  | Notes
   160  ------------- | ------------- | ------------- | -------------
   161   **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
   162    **config** | [**interface{}**](interface{}.md)| config | 
   163    **id** | **string**| id | 
   164   **optional** | ***V2CanaryConfigControllerApiUpdateCanaryConfigUsingPUTOpts** | optional parameters | nil if no parameters
   165  
   166  ### Optional Parameters
   167  Optional parameters are passed through a pointer to a V2CanaryConfigControllerApiUpdateCanaryConfigUsingPUTOpts struct
   168  
   169  Name | Type | Description  | Notes
   170  ------------- | ------------- | ------------- | -------------
   171  
   172  
   173   **configurationAccountName** | **optional.String**| configurationAccountName | 
   174  
   175  ### Return type
   176  
   177  [**interface{}**](interface{}.md)
   178  
   179  ### Authorization
   180  
   181  No authorization required
   182  
   183  ### HTTP request headers
   184  
   185   - **Content-Type**: application/json
   186   - **Accept**: */*
   187  
   188  [[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)
   189