WFBSS :: Commands :: reset

Views:

Last Updated: 1/22/2020 12:11:11 AM

Asynchronously reset counter or live status iconswith given customers

Request

HTTP Request

POST /SMPI/{version}/service/wfbss/api/commands/reset

Parameters

Name	Type	Description	Validation
Required Parameters
type	string	counter or livestatus
Optional Parameters
cids	string	A list of customer ID separated by comma.	At least one customer ID must be specified, and no more than 10.
events	string	A list of events separated by comma. If set, only the specified events will be reset.	This parameter is effective when type is livestatus. Valid values: virus_incidents, spyware_incidents, wtp_incidents, urlfilter_incidents, behavior_monitoring_incidents, network_virus_incidents, virus_unsuccessful, spyware_unsuccessful, device_control_incidents

HTTP Request Example

Reset counter for customers:
POST /SMPI/{version}/service/wfbss/api/commands/reset?type=counter&cids=640FE47F-5118-4D79-8221-A35D0DE2EE2C,549390C2-61B3-417E-B1F0-8955A63C08F3

Reset virus incident status and spyware incident status for customers:
POST /SMPI/{version}/service/wfbss/api/commands/reset?type=livestatus&events=virus_incidents,spyware_incidents&cids=640FE47F-5118-4D79-8221-A35D0DE2EE2C,549390C2-61B3-417E-B1F0-8955A63C08F3

Reset all live status for customers:
POST /SMPI/{version}/service/wfbss/api/commands/reset?type=livestatus&cids=640FE47F-5118-4D79-8221-A35D0DE2EE2C,549390C2-61B3-417E-B1F0-8955A63C08F3

Do not supply a request body with this method.

Response

If successful, this method returns an HTTP 200 OK status code and a response body with the following structure:

{
    "task": {
        "status": "PENDING",
        "id": "4cab9d44-ea63-41dd-9215-ac261a3bdcff"
    }
}

Name	Type	Description	Length
task.id	string	The ID of the asynchronous task to update gobal settings.	GUID
task.status	string	The status of the asynchronous task to update gobal settings.	PENDING, STARTED, SUCCESS, FAILURE, or REVOKED