You can find our user documentation at

Check out our new API beta site!

Child pages
  • WHM API 1 Functions - verify_aim_access
Skip to end of metadata
Go to start of metadata


This function calls the WHM API 1 verify_oscar_access function with the system's specified AOL Instant Messenger (AIM) accounts.

You can specify AIM accounts in the Contact Information section of WHM's  Basic WebHost Manager Setup interface (Home >> Server Configuration >> Basic WebHost Manager Setup).


  • Because AOL discontinued AIM in December 2017, any operations that rely on this function will not perform properly.
  • We removed this function in cPanel & WHM version 70.


 Command Line
whmapi1 verify_aim_access


  • Unless otherwise noted, you must URI-encode values.
  • For more information and additional output options, read our Guide to WHM API 1 documentation or run the whmapi1 --help command.
  • If you run CloudLinux™, you must use the full path of the whmapi1 command:


 Output (JSON)
  "metadata": {
    "version": 1,
    "reason": "OK",
    "result": "1",
    "command": "verify_aim_access"
 Output (XML)


Use WHM's API Shell interface (WHM >> Home >> Development >> API Shell) to directly test WHM API calls.


This function does not accept parameters.


This function returns the results of the WHM API 1  verify_oscar_access  function.


If the Contact Information section of WHM's Basic WebHost Manager Setup interface (Home >> Server Configuration >> Basic WebHost Manager Setup) contains multiple AIM accounts, the function will return an array that contains the results for each account.