Description

This function saves a set of security questions and answers.
 The system uses these questions when users attempt to log in to cPanel or Webmail from an untrusted IP address.

Examples


https://hostname.example.com:2087/cpsess###########/json-api/cpanel?cpanel_jsonapi_user=user&cpanel_jsonapi_apiversion=2&cpanel_jsonapi_module=SourceIPCheck&cpanel_jsonapi_func=savesecquestions&account=example.com&q1answer=pumas&q1ques=What%20was%20your%20high%20school%20mascot%3F&q2answer=snowball2&q2ques=What%20was%20the%20name%20of%20your%20first%20pet%3F&q3answer=19&q3ques=How%20old%20were%20you%20at%20your%20wedding%20(Enter%20age%20as%20digits)%3F&q4answer=captial city&q4ques=In%20what%20city%20were%20you%20married%3F

$cpanel = new CPANEL(); // Connect to cPanel - only do this once.
 
// Create security questions for example.com.
$save_sec_questions = $cpanel->api2(
    'SourceIPCheck', 'savesecquestions',
		array(        
        'account'      	=> 'example',
		'q1answer'		=> 'Pumas',
		'q1ques'		=> '"What was your high school's mascot?"',
		'q2answer'		=> 'Snowball2',
		'q2ques'		=> 'What was the name of your first pet?',
		'q3answer' 		=> '19',
		'q3ques'		=> 'How old were you at your wedding?',
		'q4answer'		=> 'Capital City',
		'q4ques'		=> 'In what city were you married?',
    ) 
 );

 

my $cpliveapi = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.
 
# Create security questions security questions for example.com.
my $save_sec_questions = $cpliveapi->api2(
    'SourceIPCheck', 'savesecquestions',
    { 
        'account'      	=> 'example',
		'q1answer'		=> 'Pumas',
		'q1ques'		=> '"What was your high school's mascot?"',
		'q2answer'		=> 'Snowball2',
		'q2ques'		=> 'What was the name of your first pet',
		'q3answer' 		=> '19',
		'q3ques'		=> 'How old were you at your wedding?',
		'q4answer'		=> 'Capital City',
		'q4ques'		=> 'In what city were you married?',
	 }
 );

 

cpapi2 --user=username SourceIPCheck samplequestions account=example q1answer=Pumas q1ques="What was your high school's mascot?" q2answer=Snowball2 q2ques=> 'What was the name of your first pet?" q3answer=19 q3ques="How old were you at your wedding?" q4answer="Capital City" q4ques="In what city were you married?"

{
  "cpanelresult": {
    "apiversion": 2,
    "func": "savesecquestions",
    "data": [
      {
        "status": 1
      }
    ],
    "event": {
      "result": 1
    },
    "module": "SourceIPCheck"
  }
}

Parameters

InputTypeDescriptionPossible valuesExample
accountstring

Required

The account for which to add security questions.

Any valid account.example.com
q*answerstring

Required

The answer to each security question.

  • Replace * with the security question answer's number.
  • You must pass this parameter as q*answer:answer
  • You must specify at least four answers.

The answer that will correspond to the security question of the same incremental value.

 

 q1answer: Snowball2
q*ques 

Required

The security questions.

  • Replace * with the security question's number.
  • You must pass this parameter as q*answer:ques
  • You must specify at least four questions.
The questions that correspond to the answer of the same incremental value.q1ques: What was the name of your first pet?

Returns

ReturnTypeDescriptionPossible valuesExample
statusBoolean

Whether the function added the security questions and answers.

  • 1 — Added
  • 0 — Not added.
1
reasonstring

A reason for failure.

This function only returns a reason value if there was an error.

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