cPanel API 2 Functions - SourceIPCheck::samplequestions

Warning:

The cPanel API 2 system is deprecated. We strongly recommend that you use UAPI instead of cPanel API 2.

Description

This function retrieves a list of sample security questions.

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

Note:

For more information, read our Calls from the WHM API documentation.

LiveAPI PHP Class

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

// Retrieve list of security questions.
$get_security_questions = $cpanel->api2(
    'SourceIPCheck', 'samplequestions'

 );

Note:

For more information, read our Guide to the LiveAPI System.

LiveAPI Perl Module

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

# Retrieve list of security questions.
my $get_security_questions = $cpliveapi->api2(
    'SourceIPCheck', 'samplequestions',

 );

Note:

For more information, read our Guide to the LiveAPI System.

cPanel Tag System (deprecated)

Warnings:

cPanel tags are deprecated . We strongly recommend that you only use the LiveAPI system to call the cPanel APIs. Examples are only present in order to help developers move from the old cPanel tag system to our LiveAPI .
cPanel API 2 calls that use cPanel tags vary in code syntax and in their output.
For more information, read our Deprecated cPanel Tag Usage documentation.

Command Line

cpapi2 --user=username SourceIPCheck samplequestions

Notes:

You must URI-encode values.
username represents your account-level username.
You must include the --user=username option.
For more information and additional output options, read our Guide to cPanel API 2 documentation or run the cpapi2 --help command.
If you run CloudLinux™, you must use the full path of the cpapi2 command:
```
/usr/local/cpanel/bin/cpapi2
```

Output (JSON)

{
  "cpanelresult": {
    "apiversion": 2,
    "func": "samplequestions",
    "data": [
      "What is your primary frequent flyer number?",
      "What is your library card number?",
      "What was your first phone number?",
      "What was your first teacher\u2019s name?",
      "What is your father\u2019s middle name?",
      "What is your maternal grandmother\u2019s first name?",
      "In what city was your high school?",
      "What was the name of your first boyfriend or girlfriend?",
      "What is your maternal grandfather\u2019s first name?",
      "In what city were you born (Enter full name of city only)?",
      "What was the name of your first pet?",
      "What was your high school mascot?",
      "How old were you at your wedding (Enter age as digits)?",
      "In what year (YYYY) did you graduate from high school?",
      "In what city did you honeymoon (Enter full name of city only)?",
      "What is the first name of the best man\/maid of honor at your wedding?",
      "What is your paternal grandmother\u2019s first name?",
      "What is your mother\u2019s middle name?",
      "In what city were you married?",
      "In what city is your vacation home?",
      "What is the first name of your first child?",
      "What is your paternal grandfather\u2019s first name?",
      "What is the name of your first employer?",
      "When is your wedding anniversary (Enter the full name of month)?",
      "What is your paternal grandfather\u2019s first name?",
      "What is the first name of the best man\/maid of honor at your wedding?",
      "In what city was your mother born (Enter full name of city only)?",
      "In what city was your father born (Enter full name of city only)?"
    ],
    "event": {
      "result": 1
    },
    "module": "SourceIPCheck"
  }
}

Note:

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

Parameters

This function does not accept parameters.

Returns

Return Type Description Possible values Example

Return	Type	Description	Possible values	Example
`data`	array	An array of security questions.	A comma-separated list of available security questions.	`What was the name of your first pet?`
`reason`	string	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.`
`result`	Boolean	Whether the function succeeded.	`1` — The function succeeded. `0` — The function failed.	`1`

data

array

An array of security questions.

A comma-separated list of available security questions.

What was the name of your first pet?

reason

string

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.

result

Boolean

Whether the function succeeded.

1 — The function succeeded.
0 — The function failed.

1