Description

This function cleans up the scan log file after you complete a scan with the WordPressInstanceManager::start_scan function.

 To read more information about the complete scan process, read our UAPI Functions - WordPressInstanceManager::start_scan documentation.

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


Examples 




https://hostname.example.com:2083/cpsess##########/execute/WordPressInstanceManager/cleanup_scan?guid=B3A27B96-51F7-11E8-92E3-CC90C4F823F0



$cpanel = new CPANEL(); // Connect to cPanel - only do this once.
 
// Clean up WordPress scan log file.
 $instances = $cpanel->uapi(
    'WordPressInstanceManager', 'cleanup_scan',
	array(	
		'guid' => 'B3A27B96-51F7-11E8-92E3-CC90C4F823F0'
	)
);



my $cpliveapi = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.
 
# Clean up WordPress scan log file.
my $instances = $cpliveapi->uapi(
    'WordPressInstanceManager', 'cleanup_scan',
	{
		'guid' => 'B3A27B96-51F7-11E8-92E3-CC90C4F823F0'
	}
);



<!-- Clean up WordPress scan log file. -->
[% data = execute( 'WordPressInstanceManager', 'cleanup_scan' , { 'guid' => 'B3A27B96-51F7-11E8-92E3-CC90C4F823F0' } ); %]



uapi --user=username WordPressInstanceManager cleanup_scan guid=B3A27B96-51F7-11E8-92E3-CC90C4F823F0



{
	"data": null,
	"status": 1,
	"metadata": {},
	"messages": null,
	"errors": null,
	"warnings": null
}



Parameters

ParameterTypeDescriptionPossible vaulesExample
guidstring

Required

A scan's unique ID.

A valid string.

The system provides this parameter's value in the guid return with the WordPressInstanceManager::start_scan function.


B3A27B96-51F7-11E8-92E3-CC90C4F823F0

Returns

This function only returns metadata.