Child pages
  • cPanel API 2 Functions - NVData::set

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Description

Excerpt
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
titleWarning:

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

  • UAPI (recommended) — NVData::set —
    Excerpt Include
    SDK:UAPI Functions - NVData::set
    SDK:UAPI Functions - NVData::set
    nopaneltrue

Panel
bgColor#F2F2F2
borderStylenone

Examples 


Panel
bgColor#FFFFFF
borderStylenone


Expand
titleWHM API (JSON)


Code Block
languagetext
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

Include Page
LIB:_CallFromWHMAPILink
LIB:_CallFromWHMAPILink


Expand
titleLiveAPI PHP Class


Code Block
languagephp
linenumberstrue
$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'
    ) 
);

Include Page
LIB:_LiveAPIPHPLink
LIB:_LiveAPIPHPLink

 


Expand
titleLiveAPI Perl Module


Code Block
languageperl
linenumberstrue
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'
    }
);

Include Page
LIB:_LiveAPIPerlLink
LIB:_LiveAPIPerlLink

 


Expand
titlecPanel Tag System (deprecated)

Include Page
LIB:_cPanelAPI2cPanelTagsWarning
LIB:_cPanelAPI2cPanelTagsWarning


Expand
titleCommand Line


Code Block
languagebash
cpapi2 --user=username NVData set names=mymind mymind=you

Include Page
LIB:_cPanelAPI2CLINote
LIB:_cPanelAPI2CLINote


Expand
titleOutput (JSON)


Code Block
languagetext
linenumberstrue
{
  "cpanelresult": {
    "apiversion": 2,
    "func": "set",
    "data": [
      
    ],
    "event": {
      "result": 1
    },
    "module": "NVData"
  }
}


Include Page
LIB:_cPanelAPIShellNote
LIB:_cPanelAPIShellNote


   

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
titleNote:

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
titleNote:

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