Skip to content

HostingCacheApi.md

Latest commit

 

History

History
160 lines (109 loc) · 6.46 KB

HostingCacheApi.md

File metadata and controls

160 lines (109 loc) · 6.46 KB
Raw

Hostinger\HostingCacheApi

All URIs are relative to https://developers.hostinger.com, except if the operation defines another base path.

Method HTTP request Description
clearWebsiteCacheV1() DELETE /api/hosting/v1/accounts/{username}/websites/{domain}/cache/clear Clear website cache
toggleCachelessModeV1() PATCH /api/hosting/v1/accounts/{username}/websites/{domain}/cacheless-mode/toggle Toggle cacheless mode
toggleWebsiteCacheV1() PATCH /api/hosting/v1/accounts/{username}/websites/{domain}/cache/toggle Toggle website cache

clearWebsiteCacheV1()

clearWebsiteCacheV1($username, $domain, $directory): \Hostinger\Model\CommonSuccessEmptyResource

Clear website cache

Permanently clears all server-side cache for the website at once. Use it when content was updated and needs to be visible immediately, or after making major changes. Also purges the Hostinger CDN cache when CDN is enabled on the website. For a WordPress installation living in a subdirectory, pass the directory query parameter to clear its cache.

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure Bearer authorization: apiToken
$config = Hostinger\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new Hostinger\Api\HostingCacheApi(config: $config);
$username = u123456789; // string
$domain = mydomain.tld; // string | Domain name
$directory = blog; // string | Directory of the website installation to clear, relative to the website root. Defaults to the website root.

try {
    $result = $apiInstance->clearWebsiteCacheV1($username, $domain, $directory);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling HostingCacheApi->clearWebsiteCacheV1: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name Type Description Notes
username string
domain string Domain name
directory string Directory of the website installation to clear, relative to the website root. Defaults to the website root. [optional]

Return type

\Hostinger\Model\CommonSuccessEmptyResource

[Back to top] [Back to API list] [Back to Model list] [Back to README]

toggleCachelessModeV1()

toggleCachelessModeV1($username, $domain, $hostingV1CacheToggleCachelessModeRequest): \Hostinger\Model\CommonSuccessEmptyResource

Toggle cacheless mode

Turns development (cacheless) mode on or off, based on the enabled flag. When enabled, nothing is cached, effectively turning off all caching for the website; use it while actively developing, testing changes, debugging issues, or when real-time updates must be visible. Disable it after finishing development work to restore the performance benefits of caching.

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure Bearer authorization: apiToken
$config = Hostinger\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new Hostinger\Api\HostingCacheApi(config: $config);
$username = u123456789; // string
$domain = mydomain.tld; // string | Domain name
$hostingV1CacheToggleCachelessModeRequest = new \Hostinger\Model\HostingV1CacheToggleCachelessModeRequest(); // \Hostinger\Model\HostingV1CacheToggleCachelessModeRequest

try {
    $result = $apiInstance->toggleCachelessModeV1($username, $domain, $hostingV1CacheToggleCachelessModeRequest);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling HostingCacheApi->toggleCachelessModeV1: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name Type Description Notes
username string
domain string Domain name
hostingV1CacheToggleCachelessModeRequest \Hostinger\Model\HostingV1CacheToggleCachelessModeRequest

Return type

\Hostinger\Model\CommonSuccessEmptyResource

[Back to top] [Back to API list] [Back to Model list] [Back to README]

toggleWebsiteCacheV1()

toggleWebsiteCacheV1($username, $domain, $hostingV1CacheToggleCacheRequest): \Hostinger\Model\CommonSuccessEmptyResource

Toggle website cache

Turns server-side caching for the website on or off, based on the enabled flag. Enable it for faster page loads, reduced server load, and improved user experience; recommended for production websites. Disabling may impact performance; to temporarily bypass caching while developing or debugging, prefer toggling cacheless mode instead. Does nothing if caching is already in the requested state.

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure Bearer authorization: apiToken
$config = Hostinger\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new Hostinger\Api\HostingCacheApi(config: $config);
$username = u123456789; // string
$domain = mydomain.tld; // string | Domain name
$hostingV1CacheToggleCacheRequest = new \Hostinger\Model\HostingV1CacheToggleCacheRequest(); // \Hostinger\Model\HostingV1CacheToggleCacheRequest

try {
    $result = $apiInstance->toggleWebsiteCacheV1($username, $domain, $hostingV1CacheToggleCacheRequest);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling HostingCacheApi->toggleWebsiteCacheV1: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name Type Description Notes
username string
domain string Domain name
hostingV1CacheToggleCacheRequest \Hostinger\Model\HostingV1CacheToggleCacheRequest

Return type

\Hostinger\Model\CommonSuccessEmptyResource

[Back to top] [Back to API list] [Back to Model list] [Back to README]