cPanel API 2 Functions - SourceIPCheck::loadsecquestions - Knowledgebase

Description

This function retrieves a specified set of security questions and answers.

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

LiveAPI PHP Class

$cpanel = new CPANEL(); // Connect to cPanel - only do this once.

// Load security questions for example.com.

$load_security_questions = $cpanel->api2(

'SourceIPCheck', 'loadsecquestions'

)

);

LiveAPI Perl Module

my $cpliveapi = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.

# Load security questions for example.com.

my $load_security_questions = $cpliveapi->api2(

'SourceIPCheck', 'loadsecquestions',

);

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 loadsecquestions

Notes:

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

 Output (JSON)

{
  "cpanelresult": {
    "apiversion": 2,
    "func": "loadsecquestions",
    "data": [
      {
        "questionnum": "1",
        "question": "What was the name of your first pet?",
        "options": [
          {
            "questionnum": 1,
            "selectedtxt": ""
          },
          {
            "questionnum": 2,
            "selectedtxt": ""
          },
          {
            "questionnum": 3,
            "selectedtxt": ""
          },
          {
            "questionnum": 4,
            "selectedtxt": ""
          },
          {
            "questionnum": 5,
            "selectedtxt": ""
          },
          {
            "questionnum": 6,
            "selectedtxt": ""
          },
          {
            "questionnum": 7,
            "selectedtxt": ""
          }
        ],
        "answer": Snowball2
    ],
    "event": {
      "result": 1
    },
    "module": "SourceIPCheck"
  }
}

Note:

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

Parameters

This function does not accept parameters.

Returns

Return	Type	Description	Possible values	Example
question	string	The security question.	Any of the account's security questions.	What was the name of your first pet?
options	array of hashes	A array of hashes of information for each possible question. Note: This function returns seven lists of hashes for each question.	This hash contains the questionnumand selectedtxt returns.
questionnum	integer	The security question's number. The function returns this value in theoptions hash.	Any positive integer.	1
selectedtxt	string	The security question's text. The function returns this value in theoptions hash.	"" The question's text.	""
answer	string	The security question's answer. Note: This return outputs null unless you specify a value in the q*answerparameter.	The question's answer.	Snowball2
reason	string	A reason for failure. Note: This function only returns a reasonvalue 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