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.

Authorizations:
Request Body schema: application/json
object

The NVData keys and values to update.

Responses

Response Schema: application/json
apiversion
integer

The version of the API.

func
string

The name of the method called.

module
string

The name of the module called.

object

Request samples

Content type
application/json
{
  • "personalization": {
    • "coffee": "hot",
    • "milk": "cold"
    }
}

Response samples

Content type
application/json
{
  • "apiversion": 3,
  • "func": "set",
  • "module": "Personalization",
  • "result": {
    • "data": {
      • "coffee": {
        • "reason": "OK",
        • "success": 1,
        • "value": "hot"
        },
      • "milk": {
        • "reason": "OK",
        • "success": 1,
        • "value": "cold"
        }
      },
    • "errors": null,
    • "messages": null,
    • "metadata": { },
    • "status": 1,
    • "warnings": null
    }
}