v1

latestOpenAPI 3.0.2cPanel License2026-08-06657427.1 MB

Personalization

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.

post/Personalization/get

Request body

namesstring[]

List of NVData keys to query the server about.

Example request

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

Response

HTTP Request was successful.

apiversioninteger

The version of the API.

funcstring

The name of the method called.

modulestring

The name of the module called.

Example response

{
  "apiversion": 3,
  "func": "get",
  "module": "Personalization",
  "result": {
    "data": {
      "coffee": {
        "reason": "OK",
        "success": 1,
        "value": "hot"
      },
      "milk": {
        "reason": "OK",
        "success": 1,
        "value": "cold"
      }
    },
    "status": 1
  }
}