github.com/launchdarkly/api-client-go@v5.3.0+incompatible/docs/RelayProxyConfigurationsApi.md (about)

     1  # \RelayProxyConfigurationsApi
     2  
     3  All URIs are relative to *https://app.launchdarkly.com/api/v2*
     4  
     5  Method | HTTP request | Description
     6  ------------- | ------------- | -------------
     7  [**DeleteRelayProxyConfig**](RelayProxyConfigurationsApi.md#DeleteRelayProxyConfig) | **Delete** /account/relay-auto-configs/{id} | Delete a relay proxy configuration by ID.
     8  [**GetRelayProxyConfig**](RelayProxyConfigurationsApi.md#GetRelayProxyConfig) | **Get** /account/relay-auto-configs/{id} | Get a single relay proxy configuration by ID.
     9  [**GetRelayProxyConfigs**](RelayProxyConfigurationsApi.md#GetRelayProxyConfigs) | **Get** /account/relay-auto-configs | Returns a list of relay proxy configurations in the account.
    10  [**PatchRelayProxyConfig**](RelayProxyConfigurationsApi.md#PatchRelayProxyConfig) | **Patch** /account/relay-auto-configs/{id} | Modify a relay proxy configuration by ID.
    11  [**PostRelayAutoConfig**](RelayProxyConfigurationsApi.md#PostRelayAutoConfig) | **Post** /account/relay-auto-configs | Create a new relay proxy config.
    12  [**ResetRelayProxyConfig**](RelayProxyConfigurationsApi.md#ResetRelayProxyConfig) | **Post** /account/relay-auto-configs/{id}/reset | Reset a relay proxy configuration's secret key with an optional expiry time for the old key.
    13  
    14  
    15  # **DeleteRelayProxyConfig**
    16  > DeleteRelayProxyConfig(ctx, id)
    17  Delete a relay proxy configuration by ID.
    18  
    19  ### Required Parameters
    20  
    21  Name | Type | Description  | Notes
    22  ------------- | ------------- | ------------- | -------------
    23   **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
    24    **id** | **string**| The relay proxy configuration ID | 
    25  
    26  ### Return type
    27  
    28   (empty response body)
    29  
    30  ### Authorization
    31  
    32  [Token](../README.md#Token)
    33  
    34  ### HTTP request headers
    35  
    36   - **Content-Type**: application/json
    37   - **Accept**: application/json
    38  
    39  [[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)
    40  
    41  # **GetRelayProxyConfig**
    42  > RelayProxyConfig GetRelayProxyConfig(ctx, id)
    43  Get a single relay proxy configuration by ID.
    44  
    45  ### Required Parameters
    46  
    47  Name | Type | Description  | Notes
    48  ------------- | ------------- | ------------- | -------------
    49   **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
    50    **id** | **string**| The relay proxy configuration ID | 
    51  
    52  ### Return type
    53  
    54  [**RelayProxyConfig**](RelayProxyConfig.md)
    55  
    56  ### Authorization
    57  
    58  [Token](../README.md#Token)
    59  
    60  ### HTTP request headers
    61  
    62   - **Content-Type**: application/json
    63   - **Accept**: application/json
    64  
    65  [[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)
    66  
    67  # **GetRelayProxyConfigs**
    68  > RelayProxyConfigs GetRelayProxyConfigs(ctx, )
    69  Returns a list of relay proxy configurations in the account.
    70  
    71  ### Required Parameters
    72  This endpoint does not need any parameter.
    73  
    74  ### Return type
    75  
    76  [**RelayProxyConfigs**](RelayProxyConfigs.md)
    77  
    78  ### Authorization
    79  
    80  [Token](../README.md#Token)
    81  
    82  ### HTTP request headers
    83  
    84   - **Content-Type**: application/json
    85   - **Accept**: application/json
    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  # **PatchRelayProxyConfig**
    90  > RelayProxyConfig PatchRelayProxyConfig(ctx, id, patchDelta)
    91  Modify a relay proxy configuration by ID.
    92  
    93  ### Required Parameters
    94  
    95  Name | Type | Description  | Notes
    96  ------------- | ------------- | ------------- | -------------
    97   **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
    98    **id** | **string**| The relay proxy configuration ID | 
    99    **patchDelta** | [**[]PatchOperation**](PatchOperation.md)| Requires a JSON Patch representation of the desired changes to the project. 'http://jsonpatch.com/' | 
   100  
   101  ### Return type
   102  
   103  [**RelayProxyConfig**](RelayProxyConfig.md)
   104  
   105  ### Authorization
   106  
   107  [Token](../README.md#Token)
   108  
   109  ### HTTP request headers
   110  
   111   - **Content-Type**: application/json
   112   - **Accept**: application/json
   113  
   114  [[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)
   115  
   116  # **PostRelayAutoConfig**
   117  > RelayProxyConfig PostRelayAutoConfig(ctx, relayProxyConfigBody)
   118  Create a new relay proxy config.
   119  
   120  ### Required Parameters
   121  
   122  Name | Type | Description  | Notes
   123  ------------- | ------------- | ------------- | -------------
   124   **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
   125    **relayProxyConfigBody** | [**RelayProxyConfigBody**](RelayProxyConfigBody.md)| Create a new relay proxy configuration | 
   126  
   127  ### Return type
   128  
   129  [**RelayProxyConfig**](RelayProxyConfig.md)
   130  
   131  ### Authorization
   132  
   133  [Token](../README.md#Token)
   134  
   135  ### HTTP request headers
   136  
   137   - **Content-Type**: application/json
   138   - **Accept**: application/json
   139  
   140  [[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)
   141  
   142  # **ResetRelayProxyConfig**
   143  > RelayProxyConfig ResetRelayProxyConfig(ctx, id, optional)
   144  Reset a relay proxy configuration's secret key with an optional expiry time for the old key.
   145  
   146  ### Required Parameters
   147  
   148  Name | Type | Description  | Notes
   149  ------------- | ------------- | ------------- | -------------
   150   **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
   151    **id** | **string**| The relay proxy configuration ID | 
   152   **optional** | ***RelayProxyConfigurationsApiResetRelayProxyConfigOpts** | optional parameters | nil if no parameters
   153  
   154  ### Optional Parameters
   155  Optional parameters are passed through a pointer to a RelayProxyConfigurationsApiResetRelayProxyConfigOpts struct
   156  
   157  Name | Type | Description  | Notes
   158  ------------- | ------------- | ------------- | -------------
   159  
   160   **expiry** | **optional.Int64**| An expiration time for the old relay proxy configuration key, expressed as a Unix epoch time in milliseconds. By default, the relay proxy configuration will expire immediately | 
   161  
   162  ### Return type
   163  
   164  [**RelayProxyConfig**](RelayProxyConfig.md)
   165  
   166  ### Authorization
   167  
   168  [Token](../README.md#Token)
   169  
   170  ### HTTP request headers
   171  
   172   - **Content-Type**: application/json
   173   - **Accept**: application/json
   174  
   175  [[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)
   176