REST API - checkPurgeAudit

The table summarizes the REST API - checkPurgeAudit.

Request

Format 
GET <baseurl>/audit/purge/check
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 the content of a purgeStatus element.
XML Returns the content of a purgeStatus element (from the EventCollectorManagementService schema).

Example

Request 
GET <baseurl>/audit/purge/check?requireallextendeddata=true
Response 
    {
       "xml-fragment":
       {
           "statusMessage": "No purge operation is in progress!",
           "status": "PURGE_STOPPED"
       }
    }