github.com/spinnaker/spin@v1.30.0/gateapi/docs/ServerGroupControllerApi.md (about) 1 # \ServerGroupControllerApi 2 3 All URIs are relative to *https://localhost* 4 5 Method | HTTP request | Description 6 ------------- | ------------- | ------------- 7 [**GetServerGroupDetailsUsingGET**](ServerGroupControllerApi.md#GetServerGroupDetailsUsingGET) | **Get** /applications/{applicationName}/serverGroups/{account}/{region}/{serverGroupName} | Retrieve a server group's details 8 [**GetServerGroupsForApplicationUsingGET**](ServerGroupControllerApi.md#GetServerGroupsForApplicationUsingGET) | **Get** /applications/{applicationName}/serverGroups | Retrieve a list of server groups for a given application 9 10 11 # **GetServerGroupDetailsUsingGET** 12 > interface{} GetServerGroupDetailsUsingGET(ctx, account, applicationName, region, serverGroupName, optional) 13 Retrieve a server group's details 14 15 ### Required Parameters 16 17 Name | Type | Description | Notes 18 ------------- | ------------- | ------------- | ------------- 19 **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. 20 **account** | **string**| account | 21 **applicationName** | **string**| applicationName | 22 **region** | **string**| region | 23 **serverGroupName** | **string**| serverGroupName | 24 **optional** | ***ServerGroupControllerApiGetServerGroupDetailsUsingGETOpts** | optional parameters | nil if no parameters 25 26 ### Optional Parameters 27 Optional parameters are passed through a pointer to a ServerGroupControllerApiGetServerGroupDetailsUsingGETOpts struct 28 29 Name | Type | Description | Notes 30 ------------- | ------------- | ------------- | ------------- 31 32 33 34 35 **xRateLimitApp** | **optional.String**| X-RateLimit-App | 36 **includeDetails** | **optional.String**| includeDetails | [default to true] 37 38 ### Return type 39 40 [**interface{}**](interface{}.md) 41 42 ### Authorization 43 44 No authorization required 45 46 ### HTTP request headers 47 48 - **Content-Type**: Not defined 49 - **Accept**: */* 50 51 [[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) 52 53 # **GetServerGroupsForApplicationUsingGET** 54 > []interface{} GetServerGroupsForApplicationUsingGET(ctx, applicationName, optional) 55 Retrieve a list of server groups for a given application 56 57 ### Required Parameters 58 59 Name | Type | Description | Notes 60 ------------- | ------------- | ------------- | ------------- 61 **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. 62 **applicationName** | **string**| applicationName | 63 **optional** | ***ServerGroupControllerApiGetServerGroupsForApplicationUsingGETOpts** | optional parameters | nil if no parameters 64 65 ### Optional Parameters 66 Optional parameters are passed through a pointer to a ServerGroupControllerApiGetServerGroupsForApplicationUsingGETOpts struct 67 68 Name | Type | Description | Notes 69 ------------- | ------------- | ------------- | ------------- 70 71 **xRateLimitApp** | **optional.String**| X-RateLimit-App | 72 **cloudProvider** | **optional.String**| cloudProvider | 73 **clusters** | **optional.String**| clusters | 74 **expand** | **optional.String**| expand | [default to false] 75 76 ### Return type 77 78 [**[]interface{}**](interface{}.md) 79 80 ### Authorization 81 82 No authorization required 83 84 ### HTTP request headers 85 86 - **Content-Type**: Not defined 87 - **Accept**: */* 88 89 [[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) 90