Software Development Kit

cPanel & WHM's API [+] cPanel & WHM's API [-]


Modules and Plugins [+] Modules and Plugins [-]


cPanel & WHM Hooks [+] cPanel & WHM Hooks [-]


cPAddons (Site Software) [+] cPAddons (Site Software) [-]


System Administration [+] System Administration [-]


Developer Software [+] Developer Software [-]


Back to All Documentation

Retrieve a Non-Volatile Variable Value — nvget

cPanel and WHM store "non-volatile" data on your server. You can use the nvget function to view the value of a non-volatile variable.

In order to set a variable and its value, use the nvset function.

Calling Functions

Using the XML API

To use the XML API to perform the nvget function from within your custom script:

  • Append the /xml-api/nvget function call name, plus the required variables (see below), to a URL which includes the address of your server.

  • For example, on a server whose hostname is example.com, you would include the following string in your script: https://example.com:2087/xml-api/nvget

  • You need to be logged in with the proper permissions in order to call a function. See our document about Authenticating API Function Calls for more information about authenticating APIs from within a script.

  • You can also perform the function by entering the string in your web browser's address bar. This may be useful for testing the function call and viewing its output.

Using the JSON API

To use the JSON API to perform the nvget function from within your custom script:

  • Append the /json-api/nvget function call name, plus the required variables (see below), to a URL which includes the address of your server.

  • For example, on a server whose hostname is example.com, you would include the following string in your script: https://example.com:2087/json-api/nvget

  • You need to be logged in with the proper permissions in order to call a function. See our document about Authenticating API Function Calls for more information about authenticating APIs from within a script.

  • You can also perform the function by entering the string in your web browser's address bar. This may be useful for testing the function call and viewing its output.

Variables

Input

The nvget function takes the following required variable as input:
  • key (string) — The name of the variable whose value you wish to retrieve.

Output

Show Hide
  • nvget — Root-level XML tag for the output of the nvget function.
    • value — The value of the variable you have requested.

Examples

XML API

Show Hide
Calling https://example.com:2087/xml-api/nvget?key=yourcompany:YourVariableName in WebHost Manager will produce output similar to:
<nvget>
     <value>1</value>
</nvget>

JSON API

Show Hide

Calling https://example.com:2087/json-api/nvget?key=yourcompany:YourVariableName in WebHost Manager will produce output similar to:

{
   "value":"1"
}

Topic revision: r2 - 29 Sep 2009 - 19:06:14 - MelanieSeibert