REST API - stopPurgeAudit

The table summarizes the REST API - stopPurgeAudit.

Request

Format 
DELETE <baseurl>/audit/purge/stop
Query parameters
  • requireallextendeddata=boolean (optional, default=false): Displays all the extended data options for the operation.
  • requiredextendeddata=enumeration (optional): Specifies one or more specific items of extended data (separated by semi-colons) to display. For possible values see PurgeStatus Object .

Response

JSON Returns a JSON representation of a PurgeStatus element.
XML Returns a PurgeStatus element (from the EventCollectorManagementService schema).

Example

Request 
DELETE <baseurl>/audit/purge/stop?requireallextendeddata=true
Response 
{
   "xml-fragment":
       {
           "statusMessage": "Purge operation [EC-PURGE-1373385259591] stopped successfully!",
           "purgeOperationName": "EC-PURGE-1373385259591"
           "status": "PURGE_STOPPED"
       }
}