cPanel API 2 Functions - NVData::setall - Knowledgebase

Description

This function creates a non-volatile datastore. The system creates the datastore in the /home/user/.cpanel/nvdata directory, where userrepresents the account name.

Warning:

We strongly recommend that you use UAPI instead of cPanel API 2. However, no equivalent UAPI function exists.

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=setall&mymind=you

 LiveAPI PHP Class

$cpanel = new CPANEL(); // Connect to cPanel - only do this once.
  
// Set "mymind" NVDatastore to "you"
$cloud_nine = $cpanel->api2(
    'NVData', 'setall', 
    array(
        'mymind' => 'you',
    ) 
);

 LiveAPI Perl Module

my $cpliveapi = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.
  
# Set "mymind" NVDatastore to "you"
my $cloud_nine = $cpliveapi->api2(
    'NVData', 'setall',
    {
        'mymind' => 'you',
    }
);

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": "setall",
    "data": [
      {
        "set": "mymind"
      },
    ],
    "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
datastore name Note: The NVData file to create. In the examples, we set it to mymind.	string	Required The NVData file's value.	A valid string.	you

Parameter

Type

Description

Possible values

Example

datastore name

Note:

The NVData file to create. In the examples, we set it to mymind.

string

Required

The NVData file's value.

A valid string.

you

Returns

The function creates the datastore in the /home/user/.cpanel/nvdata directory.

Return	Type	Description	Possible values	Example
set	string	The datastore's name.	A valid string.	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