Developer Documentation
Child pages
  • WHM API 1 Functions - nvset
Skip to end of metadata
Go to start of metadata

Guide to WHM API 1

Return Data

Filter Output

Sort Output

Paginate Output

Output Columns

Call cPanel API 2 and UAPI

 

 

Description


This function sets 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.

Note:

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

Examples 

 JSON API
https://hostname.example.com:2087/cpsess##########/json-api/nvset?api.version=1&key=ThermalDetonator&value=Active
 XML API
https://hostname.example.com:2087/cpsess##########/xml-api/nvset?api.version=1&key=ThermalDetonator&value=Active
 Command Line
whmapi1 nvset key=ThermalDetonator value=Active


Notes:

  • You must URI-encode values.
  • For more information and additional output options, read our Guide to WHM API 1 documentation or run the whmapi1 --help command.

  • If you run CloudLinux™, you must use the full path of the whmapi1 command:

    /usr/local/cpanel/bin/whmapi1

 Output (JSON)
{
  "data": {
    "nvdatum": [
      {
        "value": "Active",
        "key": "ThermalDetonator"
      }
    ]
  },
  "metadata": {
    "version": 1,
    "reason": "OK",
    "result": 1,
    "command": "nvset"
  }
}
 Output (XML)
<result>
    <data>
        <nvdatum>
            <value>Active</value>
            <key>ThermalDetonator</key>
        </nvdatum>
    </data>
    <metadata>
        <version>1</version>
        <reason>OK</reason>
        <result>1</result>
        <command>nvset</command>
    </metadata>
</result>


Note:

Use WHM's API Shell interface (WHM >> Home >> Development >> API Shell) to directly test WHM API calls.

   

Parameters

ParameterTypeDescriptionPossible valuesExample
keystring

Required

The variable's name.

A valid string.

ThermalDetonator
valuestring

Required

The variable's value.

A valid string.

Active

Returns

ReturnTypeDescriptionPossible valuesExample
nvdatumarray of hashes

An array of hashes of the variable's information.

This hash includes the data from the value and key returns. 

value

string

The variable's value.

This function returns this value in the nvdatum hash.

A valid string.
Active

key

string

The variable's name.

This function returns this value in the nvdatum hash.

A valid string.ThermalDetonator

 

 

Function information

API Version:

WHM API 1

Available in:

WHM 11+

Methods:

GET, POST

Required Parameters:

key, value

Return Formats:

JSON, XML

Important:

cPanel & WHM version 66 deprecated XML output.

About WHM API 1

WHM API 1 performs functions and accesses data in WHM.

Notes:

  • Some functions and parameters may require that you authenticate as the root user.
  • You must use the appropriate WHM ports (2086 or 2087) to call WHM API functions.
  

Find a function

Related functions

 

 

cPanel, WebHost Manager, and WHM are registered trademarks of cPanel, Inc. for providing its computer software that facilitates the management and configuration of Internet web servers. ®2018 All rights reserved.