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

     1  # \ImageControllerApi
     2  
     3  All URIs are relative to *https://localhost*
     4  
     5  Method | HTTP request | Description
     6  ------------- | ------------- | -------------
     7  [**FindImagesUsingGET**](ImageControllerApi.md#FindImagesUsingGET) | **Get** /images/find | Retrieve a list of images, filtered by cloud provider, region, and account
     8  [**FindTagsUsingGET**](ImageControllerApi.md#FindTagsUsingGET) | **Get** /images/tags | Find tags
     9  [**GetImageDetailsUsingGET**](ImageControllerApi.md#GetImageDetailsUsingGET) | **Get** /images/{account}/{region}/{imageId} | Get image details
    10  
    11  
    12  # **FindImagesUsingGET**
    13  > []interface{} FindImagesUsingGET(ctx, optional)
    14  Retrieve a list of images, filtered by cloud provider, region, and account
    15  
    16  The query parameter `q` filters the list of images by image name
    17  
    18  ### Required Parameters
    19  
    20  Name | Type | Description  | Notes
    21  ------------- | ------------- | ------------- | -------------
    22   **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
    23   **optional** | ***ImageControllerApiFindImagesUsingGETOpts** | optional parameters | nil if no parameters
    24  
    25  ### Optional Parameters
    26  Optional parameters are passed through a pointer to a ImageControllerApiFindImagesUsingGETOpts struct
    27  
    28  Name | Type | Description  | Notes
    29  ------------- | ------------- | ------------- | -------------
    30   **account** | **optional.String**| account | 
    31   **count** | **optional.Int32**| count | 
    32   **provider** | **optional.String**| provider | [default to aws]
    33   **q** | **optional.String**| q | 
    34   **region** | **optional.String**| region | 
    35  
    36  ### Return type
    37  
    38  [**[]interface{}**](interface{}.md)
    39  
    40  ### Authorization
    41  
    42  No authorization required
    43  
    44  ### HTTP request headers
    45  
    46   - **Content-Type**: Not defined
    47   - **Accept**: */*
    48  
    49  [[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)
    50  
    51  # **FindTagsUsingGET**
    52  > []interface{} FindTagsUsingGET(ctx, account, repository, optional)
    53  Find tags
    54  
    55  ### Required Parameters
    56  
    57  Name | Type | Description  | Notes
    58  ------------- | ------------- | ------------- | -------------
    59   **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
    60    **account** | **string**| account | 
    61    **repository** | **string**| repository | 
    62   **optional** | ***ImageControllerApiFindTagsUsingGETOpts** | optional parameters | nil if no parameters
    63  
    64  ### Optional Parameters
    65  Optional parameters are passed through a pointer to a ImageControllerApiFindTagsUsingGETOpts struct
    66  
    67  Name | Type | Description  | Notes
    68  ------------- | ------------- | ------------- | -------------
    69  
    70  
    71   **xRateLimitApp** | **optional.String**| X-RateLimit-App | 
    72   **provider** | **optional.String**| provider | [default to aws]
    73  
    74  ### Return type
    75  
    76  [**[]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  # **GetImageDetailsUsingGET**
    90  > []interface{} GetImageDetailsUsingGET(ctx, account, imageId, region, optional)
    91  Get image details
    92  
    93  ### Required Parameters
    94  
    95  Name | Type | Description  | Notes
    96  ------------- | ------------- | ------------- | -------------
    97   **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
    98    **account** | **string**| account | 
    99    **imageId** | **string**| imageId | 
   100    **region** | **string**| region | 
   101   **optional** | ***ImageControllerApiGetImageDetailsUsingGETOpts** | optional parameters | nil if no parameters
   102  
   103  ### Optional Parameters
   104  Optional parameters are passed through a pointer to a ImageControllerApiGetImageDetailsUsingGETOpts struct
   105  
   106  Name | Type | Description  | Notes
   107  ------------- | ------------- | ------------- | -------------
   108  
   109  
   110  
   111   **xRateLimitApp** | **optional.String**| X-RateLimit-App | 
   112   **provider** | **optional.String**| provider | [default to aws]
   113  
   114  ### Return type
   115  
   116  [**[]interface{}**](interface{}.md)
   117  
   118  ### Authorization
   119  
   120  No authorization required
   121  
   122  ### HTTP request headers
   123  
   124   - **Content-Type**: Not defined
   125   - **Accept**: */*
   126  
   127  [[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)
   128