Our documentation is getting an overhaul! We would like your input! Click here to take a look at the beta launch of our new documentation site! Only cPanel & WHM version 82 documentation exists on our beta at this time. 84 will be added to the new site soon! Leave your feedback here: https://go.cpanel.net/docsfeedback
UAPI Functions - LastLogin::get_last_or_current_logged_in_ip - Developer Documentation - cPanel Documentation
Child pages
  • UAPI Functions - LastLogin::get_last_or_current_logged_in_ip
Skip to end of metadata
Go to start of metadata

Description

This function returns the IP address of the user who most recently logged in.

Examples 


 cPanel or Webmail Session URL
https://hostname.example.com:2083/cpsess##########/execute/LastLogin/get_last_or_current_logged_in_ip


Note:

This example calls the UAPI function via a cPanel session. For more information, read our Guide to UAPI documentation. 

 LiveAPI PHP Class
$cpanel = new CPANEL(); // Connect to cPanel - only do this once.
 
// What is the IP address of the most recently logged-in user?
$lionel_twain = $cpanel->uapi(
    'LastLogin', 'get_last_or_current_logged_in_ip'
);


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.
 
#  What is the IP address of the most recently logged-in user?
my $lionel_twain = $cpliveapi->uapi(
    'LastLogin', 'get_last_or_current_logged_in_ip',
);


Note:

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

 Command Line
uapi --user=username LastLogin get_last_or_current_logged_in_ip


Notes:

  • You must URI-encode values.
  • username represents your account-level username.
  • For more information and additional output options, read our Guide to UAPI documentation or run the uapi --help command. 
  • If you run CloudLinux™, you must use the full path of the uapi command:

    /usr/local/cpanel/bin/uapi


 Output (JSON)
{
  "messages": null,
  "errors": null,
  "status": 1,
  "metadata": {
  },
  "data": [
    "192.168.0.1"
  ]
}


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

ReturnTypeDescriptionPossible valuesExample
dataarrayThe IP address of the user who most recently logged in.A list of valid IP addresses.
192.168.0.1