cPanel API 2 Functions - SourceIPCheck::savesecquestions - Knowledgebase

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.

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=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

 LiveAPI PHP Class

$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?',
    )
 );

 LiveAPI Perl Module

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?',
     }
 );

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.

Command Line

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?"

Notes:

You must URI-encode values.
username represents your account-level username.

Output (JSON)

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	Required The account for which to add security questions.	Any valid account.	example.com
q*answer	string	Required The answer to each security question. Important: Replace * with the security question answer's number. You must pass this parameter as qanswer: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 qanswer: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

Return	Type	Description	Possible values	Example
status	Boolean	Whether the function added the security questions and answers.	1 — Added 0 — Not added.	1
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