Description


This function retrieves the value of a non-volatile variable.

 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.

We deprecated this function in cPanel & WHM version 74. Instead, we recommend that you use the WHM API 1 Functions - personalization_get function.


Examples




https://hostname.example.com:2087/cpsess##########/json-api/nvget?api.version=1&key=ThermalDetonator




https://hostname.example.com:2087/cpsess##########/xml-api/nvget?api.version=1&key=ThermalDetonator




whmapi1 nvget key=ThermalDetonator



{
  "data": {
    "nvdatum": {
      "value": [
        "Active"
      ],
      "key": "ThermalDetonator"
    }
  },
  "metadata": {
    "version": 1,
    "reason": "OK",
    "result": 1,
    "command": "nvget"
  }
}




<result>
    <data>
        <nvdatum>
            <value>Active</value>
            <key>ThermalDetonator</key>
        </nvdatum>
    </data>
    <metadata>
        <version>1</version>
        <reason>OK</reason>
        <result>1</result>
        <command>nvget</command>
    </metadata>
</result>



   

Parameters

ParameterTypeDescriptionPossible valuesExample
keystring

Required

The variable's name.

A valid string.

ThermalDetonator

Returns

ReturnTypeDescriptionPossible valuesExample
nvdatumhash

A hash of the variable's information.

This hash includes the data from the value array and key return. 

value

array

The variable's value.

This function returns this value in the nvdatum hash.

A valid list of strings.
Active

key

string

The variable's name.

This function returns this value in the nvdatum hash.

A valid string.
ThermalDetonator