Child pages
  • UAPI Functions - WordPressInstanceManager::cancel_scan
Skip to end of metadata
Go to start of metadata

Description

This function cancels a scan that you start with the WordPressInstanceManager::start_scan function.

Note:

You must install the WordPress Manager cPanel plugin to access this API function.

Examples 


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


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.
 
// Cancel WordPress instance scan.
 $instances = $cpanel->uapi(
    'WordPressInstanceManager', 'cancel_scan'
);


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.
 
# Cancel WordPress instance scan.
my $instances = $cpliveapi->uapi(
    'WordPressInstanceManager', 'cancel_scan'
);


Note:

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

 cPanel Template Toolkit
<!-- Cancel WordPress instance scan. -->
[% data = execute( 'WordPressInstanceManager', 'cancel_scan' ); %]


Note:

For more information, read our Guide to Template Toolkit documentation. 

 Command Line
uapi --user=username WordPressInstanceManager cancel_scan


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)
{
	"warnings": null,
	"data": 0,
	"errors": null,
	"status": 1,
	"messages": null,
	"metadata": {}
}


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 valueExample
dataBooleanWhether the system cancelled the scan.
  • 1 — Cancelled.
  • 0 — Not cancelled.
0