Child pages
  • cPanel API 2 Functions - NVData::set
Skip to end of metadata
Go to start of metadata

Description

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

Warning:

We strongly recommend that you use UAPI instead of cPanel API 2.

  • UAPI (recommended) — NVData::set — This function creates a non-volatile datastore.

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


Note:

 For more information, read our Calls from the WHM API documentation.

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


Note:

For more information, read our Guide to the LiveAPI System.

 

 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', 'set',
    { 
        'names'  => 'mymind',
        'mymind' => 'you'
    }
);


Note:

For more information, read our Guide to the LiveAPI System.

 

 cPanel Tag System (deprecated)


Warnings:

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

 Command Line
cpapi2 --user=username NVData set names=mymind mymind=you


Notes:

  • You must URI-encode values.
  • username represents your account-level username.
  • You must run the --user=username command.
  • For more information and additional output options, read our Guide to cPanel API 2 documentation or run the cpapi2 --help command.
  • If you run CloudLinux™, you must use the full path of the cpapi2 command:

    /usr/local/cpanel/bin/cpapi2

 Output (JSON)
{
  "cpanelresult": {
    "apiversion": 2,
    "func": "set",
    "data": [
      
    ],
    "event": {
      "result": 1
    },
    "module": "NVData"
  }
}


Note:

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

   

Parameters

ParameterTypeDescriptionPossible valuesExample
namesstring

Required

A list of one or more NVData file names.

A valid NVData file name.mymind

datastore name

 

string

Required

The NVData file's contents.

Note:

You must use the name of each NVData file that you specified in the names value as a parameter name.

A valid string.you

Returns

Return TypeDescriptionPossible valuesExample
reasonstring

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.
resultBoolean

Whether the function succeeded.

  • 1 — The function succeeded.
  • 0 — The function failed.
1