Return data from NVData 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.

Note:

You can only call this function as a JSON request. For more information about additional output options, run the whmapi1 --help command.

Authorizations:
Request Body schema: application/json
names
Array of strings <= 2048 characters Nullable

A list of NVData keys stored on the server.

Note:

If you did not set a value for the requested keys, the system returns a null value.

store
string <= 128 characters

The name in which to store the values.

Responses

Response Schema: application/json
object
object

Request samples

Content type
application/json
{
  • "names": [
    • "milk",
    • "coffee"
    ],
  • "store": "beverages"
}

Response samples

Content type
application/json
{
  • "data": {
    • "personalization": {
      • "coffee": {
        • "reason": "OK",
        • "success": 1,
        • "value": "hot"
        },
      • "milk": {
        • "reason": "OK",
        • "success": 1,
        • "value": "cold"
        }
      }
    },
  • "metadata": {
    • "command": "personalization_get",
    • "reason": "OK",
    • "result": 1,
    • "version": 1
    }
}