latestOpenAPI 3.0.2cPanel License2026-08-106251554.3 MB

3da41671c02c

Server Administration
Account Management

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.

post/personalization_get

Request body

namesstring[] 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.

storestring

The name under which the values are stored.

Example request

{
  "names": [
    "milk",
    "coffee"
  ],
  "store": "beverages"
}

Response

HTTP Request was successful.

Example response

{
  "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
  }
}