|
| 1 | +# hostinger_api.AgencyHostingCacheApi |
| 2 | + |
| 3 | +All URIs are relative to *https://developers.hostinger.com* |
| 4 | + |
| 5 | +Method | HTTP request | Description |
| 6 | +------------- | ------------- | ------------- |
| 7 | +[**clear_agency_plan_website_cache_v1**](AgencyHostingCacheApi.md#clear_agency_plan_website_cache_v1) | **DELETE** /api/agency-hosting/v1/websites/{website_uid}/cache | Clear Agency Plan website cache |
| 8 | + |
| 9 | + |
| 10 | +# **clear_agency_plan_website_cache_v1** |
| 11 | +> CommonSuccessEmptyResource clear_agency_plan_website_cache_v1(website_uid) |
| 12 | +
|
| 13 | +Clear Agency Plan website cache |
| 14 | + |
| 15 | +Clears cache for all domains associated with an Agency Plan website, including its preview domain. |
| 16 | + |
| 17 | +This operation clears all cache types for the website. |
| 18 | + |
| 19 | +### Example |
| 20 | + |
| 21 | +* Bearer Authentication (apiToken): |
| 22 | + |
| 23 | +```python |
| 24 | +import hostinger_api |
| 25 | +from hostinger_api.models.common_success_empty_resource import CommonSuccessEmptyResource |
| 26 | +from hostinger_api.rest import ApiException |
| 27 | +from pprint import pprint |
| 28 | + |
| 29 | + |
| 30 | +# Configure Bearer authorization: apiToken |
| 31 | +configuration = hostinger_api.Configuration( |
| 32 | + access_token = os.environ["BEARER_TOKEN"] |
| 33 | +) |
| 34 | + |
| 35 | +# Enter a context with an instance of the API client |
| 36 | +with hostinger_api.ApiClient(configuration) as api_client: |
| 37 | + # Create an instance of the API class |
| 38 | + api_instance = hostinger_api.AgencyHostingCacheApi(api_client) |
| 39 | + website_uid = 'zpwlGlp19' # str | Agency Plan website UID |
| 40 | + |
| 41 | + try: |
| 42 | + # Clear Agency Plan website cache |
| 43 | + api_response = api_instance.clear_agency_plan_website_cache_v1(website_uid) |
| 44 | + print("The response of AgencyHostingCacheApi->clear_agency_plan_website_cache_v1:\n") |
| 45 | + pprint(api_response) |
| 46 | + except Exception as e: |
| 47 | + print("Exception when calling AgencyHostingCacheApi->clear_agency_plan_website_cache_v1: %s\n" % e) |
| 48 | +``` |
| 49 | + |
| 50 | + |
| 51 | + |
| 52 | +### Parameters |
| 53 | + |
| 54 | + |
| 55 | +Name | Type | Description | Notes |
| 56 | +------------- | ------------- | ------------- | ------------- |
| 57 | + **website_uid** | **str**| Agency Plan website UID | |
| 58 | + |
| 59 | +### Return type |
| 60 | + |
| 61 | +[**CommonSuccessEmptyResource**](CommonSuccessEmptyResource.md) |
| 62 | + |
| 63 | +### Authorization |
| 64 | + |
| 65 | +[apiToken](../README.md#apiToken) |
| 66 | + |
| 67 | +### HTTP request headers |
| 68 | + |
| 69 | + - **Content-Type**: Not defined |
| 70 | + - **Accept**: application/json |
| 71 | + |
| 72 | +### HTTP response details |
| 73 | + |
| 74 | +| Status code | Description | Response headers | |
| 75 | +|-------------|-------------|------------------| |
| 76 | +**200** | Success empty response | - | |
| 77 | +**401** | Unauthenticated response | - | |
| 78 | +**500** | Error response | - | |
| 79 | + |
| 80 | +[[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) |
| 81 | + |
0 commit comments