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

     1  # \NetworkControllerApi
     2  
     3  All URIs are relative to *https://localhost*
     4  
     5  Method | HTTP request | Description
     6  ------------- | ------------- | -------------
     7  [**AllByCloudProviderUsingGET**](NetworkControllerApi.md#AllByCloudProviderUsingGET) | **Get** /networks/{cloudProvider} | Retrieve a list of networks for a given cloud provider
     8  [**AllUsingGET2**](NetworkControllerApi.md#AllUsingGET2) | **Get** /networks | Retrieve a list of networks, grouped by cloud provider
     9  
    10  
    11  # **AllByCloudProviderUsingGET**
    12  > []interface{} AllByCloudProviderUsingGET(ctx, cloudProvider, optional)
    13  Retrieve a list of networks for a given cloud provider
    14  
    15  ### Required Parameters
    16  
    17  Name | Type | Description  | Notes
    18  ------------- | ------------- | ------------- | -------------
    19   **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
    20    **cloudProvider** | **string**| cloudProvider | 
    21   **optional** | ***NetworkControllerApiAllByCloudProviderUsingGETOpts** | optional parameters | nil if no parameters
    22  
    23  ### Optional Parameters
    24  Optional parameters are passed through a pointer to a NetworkControllerApiAllByCloudProviderUsingGETOpts struct
    25  
    26  Name | Type | Description  | Notes
    27  ------------- | ------------- | ------------- | -------------
    28  
    29   **xRateLimitApp** | **optional.String**| X-RateLimit-App | 
    30  
    31  ### Return type
    32  
    33  [**[]interface{}**](interface{}.md)
    34  
    35  ### Authorization
    36  
    37  No authorization required
    38  
    39  ### HTTP request headers
    40  
    41   - **Content-Type**: Not defined
    42   - **Accept**: */*
    43  
    44  [[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)
    45  
    46  # **AllUsingGET2**
    47  > map[string]interface{} AllUsingGET2(ctx, optional)
    48  Retrieve a list of networks, grouped by cloud provider
    49  
    50  ### Required Parameters
    51  
    52  Name | Type | Description  | Notes
    53  ------------- | ------------- | ------------- | -------------
    54   **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
    55   **optional** | ***NetworkControllerApiAllUsingGET2Opts** | optional parameters | nil if no parameters
    56  
    57  ### Optional Parameters
    58  Optional parameters are passed through a pointer to a NetworkControllerApiAllUsingGET2Opts struct
    59  
    60  Name | Type | Description  | Notes
    61  ------------- | ------------- | ------------- | -------------
    62   **xRateLimitApp** | **optional.String**| X-RateLimit-App | 
    63  
    64  ### Return type
    65  
    66  [**map[string]interface{}**](interface{}.md)
    67  
    68  ### Authorization
    69  
    70  No authorization required
    71  
    72  ### HTTP request headers
    73  
    74   - **Content-Type**: Not defined
    75   - **Accept**: */*
    76  
    77  [[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)
    78