cPanel API 2 Functions - NVData::get - Knowledgebase

Description

This function retrieves data from a non-volatile datastore. Files are located in the /home/user/.cpanel/nvdata directory, where userrepresents the account name.

Warning:

We strongly recommend that you use the following UAPI function instead of this function:

NVData::get — This function retrieves an environment variable's value.

Examples

WHM API (JSON)

https://hostname.example.com:2087/cpsess###########/json-api/cpanel?cpanel_jsonapi_user=user&cpanel_jsonapi_apiversion=2&cpanel_jsonapi_module=NVData&cpanel_jsonapi_func=get&names=mymind

 LiveAPI PHP Class

$cpanel = new CPANEL(); // Connect to cPanel - only do this once.
  
// Retrieve data from the "mymind" environment store
$retrieve_data = $cpanel->api2(
    'NVData', 'get', 
    array(
        'names' => 'mymind',
    ) 
);

 LiveAPI Perl Module

my $cpliveapi = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.
  
# Retrieve data from the "mymind" environment store
my $retrieve_data = $cpliveapi->api2(
    'NVData', 'get',
    {
        'names' => 'mymind',
    }
);

cPanel Tag System (deprecated)

Warning:

In cPanel & WHM version 11.30 and later, cPanel tags are deprecated. We strongly recommend that you only use the LiveAPI system to call the cPanel APIs.

cPanel API 2 calls that use cPanel tags vary widely in code syntax and in their output. For more information, read our Deprecated cPanel Tag Usage documentation. Examples are only present in order to help developers move from the old cPanel tag system to our LiveAPI.

 Output (JSON)

 {
  "cpanelresult": {
    "apiversion": 2,
    "func": "get",
    "data": [
      {
        "value": "you",
        "name": "mind"
      }
    ],
    "event": {
      "result": 1
    },
    "module": "NVData"
  }
}

Note:

Use cPanel's API Shell interface (Home >> Advanced >> API Shell) to directly test cPanel API calls.

Parameters

Parameter	Type	Description	Possible values	Example
names	string	Required The NVData file's name.	A valid file name. Note: To retrieve multiple files, separate the file names with a pipe (\|) character.	mymind

Parameter

Type

Description

Possible values

Example

names

string

Required

The NVData file's name.

A valid file name.

Note:

To retrieve multiple files, separate the file names with a pipe (|) character.

mymind

Returns

Parameter	Type	Description	Possible values	Example
value	string	The NVData file name.	A valid file name.	you
name	string	The value in the NVData file.	A valid file name.	mymind
reason	string	A reason for failure. Note: This function only returns a reason value if it failed.	A string that describes the error.	This is an error message.
result	boolean	Whether the function succeeded.	1 — The function succeeded. 0 — The function failed.	1

Knowledgebase

Categories

Categories