github.com/safedep/dry@v0.0.0-20241016050132-a15651f0548b/apiguard/tykgen/docs/HotReloadApi.md (about)

     1  # {{classname}}
     2  
     3  All URIs are relative to *http://localhost/*
     4  
     5  Method | HTTP request | Description
     6  ------------- | ------------- | -------------
     7  [**HotReload**](HotReloadApi.md#HotReload) | **Get** /tyk/reload/ | Hot-reload a single node
     8  [**HotReloadGroup**](HotReloadApi.md#HotReloadGroup) | **Get** /tyk/reload/group | Hot-reload a Tyk group
     9  
    10  # **HotReload**
    11  > ApiStatusMessage HotReload(ctx, optional)
    12  Hot-reload a single node
    13  
    14  Tyk is capable of reloading configurations without having to stop serving requests. This means that API configurations can be added at runtime, or even modified at runtime and those rules applied immediately without any downtime.
    15  
    16  ### Required Parameters
    17  
    18  Name | Type | Description  | Notes
    19  ------------- | ------------- | ------------- | -------------
    20   **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
    21   **optional** | ***HotReloadApiHotReloadOpts** | optional parameters | nil if no parameters
    22  
    23  ### Optional Parameters
    24  Optional parameters are passed through a pointer to a HotReloadApiHotReloadOpts struct
    25  Name | Type | Description  | Notes
    26  ------------- | ------------- | ------------- | -------------
    27   **block** | **optional.Bool**| Block a response until the reload is performed. This can be useful in scripting environments like CI/CD workflows. | 
    28  
    29  ### Return type
    30  
    31  [**ApiStatusMessage**](apiStatusMessage.md)
    32  
    33  ### Authorization
    34  
    35  [api_key](../README.md#api_key)
    36  
    37  ### HTTP request headers
    38  
    39   - **Content-Type**: Not defined
    40   - **Accept**: application/json
    41  
    42  [[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)
    43  
    44  # **HotReloadGroup**
    45  > ApiStatusMessage HotReloadGroup(ctx, )
    46  Hot-reload a Tyk group
    47  
    48  To reload a whole group of Tyk nodes (without using the Dashboard or host manager). You can send an API request to a single node, this node will then send a notification through the pub/sub infrastructure to all other listening nodes (including the host manager if it is being used to manage NginX) which will then trigger a global reload.
    49  
    50  ### Required Parameters
    51  This endpoint does not need any parameter.
    52  
    53  ### Return type
    54  
    55  [**ApiStatusMessage**](apiStatusMessage.md)
    56  
    57  ### Authorization
    58  
    59  [api_key](../README.md#api_key)
    60  
    61  ### HTTP request headers
    62  
    63   - **Content-Type**: Not defined
    64   - **Accept**: application/json
    65  
    66  [[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)
    67