Personalization

2 functions, invoked through the cpanel_uapi tool.

scope cpanel:uapi

Call any function with cpanel_uapi(service_id, module="Personalization", function, params). Live availability depends on the cPanel features JetHost has enabled on your account — call list_cpanel_operations to see what is active.

get POST#

Retrieve NVData data from file

This function retrieves the data from an NVData file on disk. cPanel NVData is a per-account configuration storage mechanism that you can use to maintain persistent cPanel & WHM settings across multiple sessions. This includes custom settings for your own themes and plugins.

Note:

NVData keys and values are limited to 128 and 2048 bytes, respectively.

namesarray<any>Optional

List of NVData keys to query the server about.

Response — normalized as { ok, data, errors[], warnings[] }; data contains:

personalizationany

The retrieved NVData information stored on the server. Note: You set this return's name based on the keys that you provide in the personalization parameter with the UAPI Personalization::set function. This return's name is the NVData key's name.

set POST#

Save NVData data to file

This function saves its data to an NVData file on disk. cPanel NVData is a per-account configuration storage mechanism that you can use to maintain persistent cPanel & WHM settings across multiple sessions. This includes custom settings for your own themes and plugins.

Note:

NVData keys and values are limited to 128 and 2048 bytes, respectively.

personalizationobjectOptional

The NVData keys and values to update.

Response — normalized as { ok, data, errors[], warnings[] }; data contains:

personalizationany

The saved NVData information stored on the server. Note: You set this return's name based on the keys that you provide in the personalization parameter.