cPanel API 2 Functions - SourceIPCheck::resetsecquestions - Knowledgebase

Description

This function removes security questions and answers for a specific cPanel or Webmail user.

Warning:

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

Important:

After this functions runs, the system prompts the user to redefine security questions on the next login attempt.

Examples

WHM API (JSON)

https://hostname.example.com:2087/cpsess###########/json-api/cpanel?cpanel_jsonapi_user=user&cpanel_jsonapi_apiversion=2&cpanel_jsonapi_module=SourceIPCheck&cpanel_jsonapi_func=resetsecquestions&account=example.com

 LiveAPI PHP Class

$cpanel = new CPANEL(); // Connect to cPanel - only do this once.
  
// Remove security questions for example.com
$remove_sec_questions = $cpanel->api2(
    'SourceIPCheck', 'resetsecquestions',
        array(       
            'account'      => 'user'
    )
 );

 LiveAPI Perl Module

my $cpliveapi = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.
  
# Remove security questions for example.com.
my $remove_sec_questions = $cpliveapi->api2(
    'SourceIPCheck', 'addip',
    {
        'account'      => 'user'
 
    }
 );

cPanel Tag System (deprecated)

Warning:

In cPanel & WHM version 11.30 and later, cPanel tags are deprecated. We strongly recommend that you only use theLiveAPI 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 ourDeprecated 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": "resetsecquestions",
    "data": [
      {
        "status": ""
      }
    ],
    "event": {
      "result": 1
    },
    "module": "SourceIPCheck"
  }
}

Note:

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

Parameters

Input	Type	Description	Possible values	Example
account	string	The cPanel or Wemail user for which to reset security questions.	A valid cPanel account username or Webmail email address.	user

Returns

Return	Type	Description	Possible values	Example
status	string	Whether the function reset the security questions.	"" — Success. An error message — Failure.	""
reason	string	A reason for failure. Note: This function only returns a reason value if there was an error.	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