github.com/spinnaker/spin@v1.30.0/gateapi/docs/FirewallControllerApi.md (about) 1 # \FirewallControllerApi 2 3 All URIs are relative to *https://localhost* 4 5 Method | HTTP request | Description 6 ------------- | ------------- | ------------- 7 [**AllByAccountAndRegionUsingGET**](FirewallControllerApi.md#AllByAccountAndRegionUsingGET) | **Get** /firewalls/{account}/{region} | Retrieve a list of firewalls for a given account and region 8 [**AllByAccountUsingGET**](FirewallControllerApi.md#AllByAccountUsingGET) | **Get** /firewalls/{account} | Retrieve a list of firewalls for a given account, grouped by region 9 [**AllUsingGET1**](FirewallControllerApi.md#AllUsingGET1) | **Get** /firewalls | Retrieve a list of firewalls, grouped by account, cloud provider, and region 10 [**GetSecurityGroupUsingGET**](FirewallControllerApi.md#GetSecurityGroupUsingGET) | **Get** /firewalls/{account}/{region}/{name} | Retrieve a firewall's details 11 12 13 # **AllByAccountAndRegionUsingGET** 14 > []interface{} AllByAccountAndRegionUsingGET(ctx, account, region, optional) 15 Retrieve a list of firewalls for a given account and region 16 17 ### Required Parameters 18 19 Name | Type | Description | Notes 20 ------------- | ------------- | ------------- | ------------- 21 **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. 22 **account** | **string**| account | 23 **region** | **string**| region | 24 **optional** | ***FirewallControllerApiAllByAccountAndRegionUsingGETOpts** | optional parameters | nil if no parameters 25 26 ### Optional Parameters 27 Optional parameters are passed through a pointer to a FirewallControllerApiAllByAccountAndRegionUsingGETOpts struct 28 29 Name | Type | Description | Notes 30 ------------- | ------------- | ------------- | ------------- 31 32 33 **xRateLimitApp** | **optional.String**| X-RateLimit-App | 34 **provider** | **optional.String**| provider | [default to aws] 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 # **AllByAccountUsingGET** 52 > interface{} AllByAccountUsingGET(ctx, account, optional) 53 Retrieve a list of firewalls for a given account, grouped by region 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 **optional** | ***FirewallControllerApiAllByAccountUsingGETOpts** | optional parameters | nil if no parameters 62 63 ### Optional Parameters 64 Optional parameters are passed through a pointer to a FirewallControllerApiAllByAccountUsingGETOpts struct 65 66 Name | Type | Description | Notes 67 ------------- | ------------- | ------------- | ------------- 68 69 **xRateLimitApp** | **optional.String**| X-RateLimit-App | 70 **provider** | **optional.String**| provider | [default to aws] 71 72 ### Return type 73 74 [**interface{}**](interface{}.md) 75 76 ### Authorization 77 78 No authorization required 79 80 ### HTTP request headers 81 82 - **Content-Type**: Not defined 83 - **Accept**: */* 84 85 [[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) 86 87 # **AllUsingGET1** 88 > interface{} AllUsingGET1(ctx, optional) 89 Retrieve a list of firewalls, grouped by account, cloud provider, and region 90 91 ### Required Parameters 92 93 Name | Type | Description | Notes 94 ------------- | ------------- | ------------- | ------------- 95 **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. 96 **optional** | ***FirewallControllerApiAllUsingGET1Opts** | optional parameters | nil if no parameters 97 98 ### Optional Parameters 99 Optional parameters are passed through a pointer to a FirewallControllerApiAllUsingGET1Opts struct 100 101 Name | Type | Description | Notes 102 ------------- | ------------- | ------------- | ------------- 103 **xRateLimitApp** | **optional.String**| X-RateLimit-App | 104 **id** | **optional.String**| id | 105 106 ### Return type 107 108 [**interface{}**](interface{}.md) 109 110 ### Authorization 111 112 No authorization required 113 114 ### HTTP request headers 115 116 - **Content-Type**: Not defined 117 - **Accept**: */* 118 119 [[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) 120 121 # **GetSecurityGroupUsingGET** 122 > interface{} GetSecurityGroupUsingGET(ctx, account, name, region, optional) 123 Retrieve a firewall's details 124 125 ### Required Parameters 126 127 Name | Type | Description | Notes 128 ------------- | ------------- | ------------- | ------------- 129 **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. 130 **account** | **string**| account | 131 **name** | **string**| name | 132 **region** | **string**| region | 133 **optional** | ***FirewallControllerApiGetSecurityGroupUsingGETOpts** | optional parameters | nil if no parameters 134 135 ### Optional Parameters 136 Optional parameters are passed through a pointer to a FirewallControllerApiGetSecurityGroupUsingGETOpts struct 137 138 Name | Type | Description | Notes 139 ------------- | ------------- | ------------- | ------------- 140 141 142 143 **xRateLimitApp** | **optional.String**| X-RateLimit-App | 144 **provider** | **optional.String**| provider | [default to aws] 145 **vpcId** | **optional.String**| vpcId | 146 147 ### Return type 148 149 [**interface{}**](interface{}.md) 150 151 ### Authorization 152 153 No authorization required 154 155 ### HTTP request headers 156 157 - **Content-Type**: Not defined 158 - **Accept**: */* 159 160 [[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) 161