Description


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


Examples 




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




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




whmapi0 nvget key=ThermalDetonator



{
   "value":"ThermalDetonator"
}




<nvget>
     <value>ThermalDetonator</value>
</nvget>




   

Parameters

ParameterTypeDescriptionPossible valuesExample
keystring

The variable's name.

A valid string.

ThermalDetonator

 

Returns

ReturnTypeDescriptionPossible valuesExample
nvgethash

A hash of the variable value.

This hash includes the value return. 

value

string

The variable's value.

The function returns this value in the nvget hash.

A valid string.

ThermalDetonator