UAPI Functions - CacheBuster::read

Description

This function returns the current CacheBuster ID. Use this ID to work with and around a browser's caching mechanism.

Examples 


 cPanel or Webmail Session URL

https://hostname.example.com:2083/cpsess##########/execute/CacheBuster/read

 LiveAPI PHP Class

$cpanel new CPANEL(); // Connect to cPanel - only do this once.
  
// Read the CacheBuster ID.
$whoyagonnacall $cpanel->uapi(
    'CacheBuster''read'
);

 LiveAPI Perl Module

my $cpliveapi = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.
  
# Read the CacheBuster ID.
my $whoyagonnacall $cpliveapi->uapi(
    'CacheBuster''read'
);

 cPanel Template Toolkit

<!--  Read the CacheBuster ID. -->
[% data = execute( 'CacheBuster', 'read' ); %]

 Command Line

uapi --user=username CacheBuster read

 

Notes:

  • You must URI-encode values.
  • username represents your account-level username.

 Output (JSON)

{
  "messages": null,
  "errors": null,
  "status": 1,
  "metadata": {
     
  },
  "data": {
    "cache_id": "11381138"
  }
}

 

Note:

Use cPanel's API Shell interface (Home >> Advanced >> API Shell) to directly test cPanel API calls.

 

Parameters

This function does not accept parameters.

Returns

Return

Type

Description

Possible values

Example

 cache_id 

 integer 

 A random integer that the system uses to work with and around a browser's caching mechanism. 

 An eight-digit integer. 

 11381138 

 

  • 0 Users Found This Useful
Was this answer helpful?

Related Articles

The cPanel Interface

For  cPanel  &  WHM  version  58 Overview The cPanel interface is...

User Preferences

For cPanel & WHM version 58 Overview This document outlines how to access your cPanel...

Manage External Authentications

For cPanel & WHM version 58 Overview Manage credentials Additional documentation...

What is cPanelID?

In This Article:  Overview ServicesHow to get a cPanelID cPanelID External...

Guide to cPanel Interface Customization - cPanel Style Development

Introduction You can develop custom styles that modify the appearance of the cPanel interface....