You can find our user documentation at docs.cpanel.net.

Check out our new API beta site!

Child pages
  • cPanel API 1 Functions - StatManager::updateUserConfig
Skip to end of metadata
Go to start of metadata

Description

This function enables or disables a statistics program for a domain.

Warning:

cPanel API 1 is deprecated. Do not use this function. Instead, we strongly recommend that you use the following newer functions:

Important:

In cPanel & WHM version 76 and later, when you disable the Web Server role, the system disables this function.

Examples 


 LiveAPI PHP Class
$cpanel = new CPANEL(); // Connect to cPanel - only do this once.
$doform_statmanager = $cpanel->api1('StatManager','updateUserConfig', array('WEBALIZER-EXAMPLE.COM') ); // Call the function.


Note:

For more information, read our Guide to the LiveAPI System.

 LiveAPI Perl Module
my $cpliveapi = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.
my $doform_statmanager = $cpliveapi->api1('StatManager','updateUserConfig', ['WEBALIZER-EXAMPLE.COM'] ); # Call the function.


Note:

For more information, read our Guide to the LiveAPI System.


 cPanel Tag System (deprecated)


Warning:

In cPanel & WHM version 11.30 and later, cPanel tags are deprecated. We provide this example to help developers move from the old cPanel tag system to our LiveAPI system. We strongly recommend that you only use the LiveAPI system to call the cPanel APIs.

<cpanel Module="SubDomain::updateUserConfig( $FORM('WEBALIZER-EXAMPLE.COM') )">
 Command Line
cpapi1 --user=username StatManager updateUserConfig yes


Notes:

  • Unless otherwise noted, you must URI-encode values.
  • For more information and additional output options, read our Guide to WHM API 1 documentation or run the whmapi1 --help command.
  • If you run CloudLinux™, you must use the full path of the whmapi1 command:

    /usr/local/cpanel/bin/whmapi1

 Output (none)
This function does not return output.

Parameters

ParameterTypeDescriptionPossible valuesExample

STATSPROGRAM-DOMAIN.COM


string

Required

The statistics program and its domain.

Note:

The parameter's name is the statistics program's name in capital letters, a hyphen (- ), the domain name in capital letters.

  • yes — Enabled.
  • no — Disabled.
WEBALIZER-EXAMPLE.COM=yes

Returns

This function does not return output.