cwp · 2018-02-28

DescribeSecurityEventsCnt

POST

Obtain the statistics data of security overview-related events.

Wire call

Converge Cloud is RPC over HTTP. There is one path — / — and the action travels in the X-TC-Action header. The /cwp/DescribeSecurityEventsCnt path used in the OpenAPI document is a documentation convenience so each action is addressable; it is not a route on the server.

curl

curl -sS https://cwp.api3.convergecloud.com/ \
  -H 'Authorization: TC3-HMAC-SHA256 Credential=<SecretId>/<YYYY-MM-DD>/cwp/tc3_request, SignedHeaders=content-type;host;x-tc-action, Signature=<sig>' \
  -H 'Content-Type: application/json; charset=utf-8' \
  -H 'Host: cwp.api3.convergecloud.com' \
  -H 'X-TC-Action: DescribeSecurityEventsCnt' \
  -H 'X-TC-Version: 2018-02-28' \
  -H 'X-TC-Timestamp: <unix-seconds>' \
  -H 'X-TC-Region: luzon' \
  -d '{}'

Request parameters

This action takes no parameters.

Response

Fields are returned inside the Response envelope. Converge Cloud answers HTTP 200 for errors as well as successes, so read Response.Error rather than the status code — and test for the presence of that object, because Code is occasionally the empty string.

Field	Type	Description
Malware	SecurityEventInfo	Trojan file-related risk event
HostLogin	SecurityEventInfo	Log-in audit-related risk event
BruteAttack	SecurityEventInfo	Password cracking-related risk event
RiskDns	SecurityEventInfo	Malicious request-related risk event
Bash	SecurityEventInfo	High-risk command-related risk event
PrivilegeRules	SecurityEventInfo	Local privilege escalation-related risk event
ReverseShell	SecurityEventInfo	Reverse Shell-related risk event
SysVul	SecurityEventInfo	Application vulnerability-related risk event
WebVul	SecurityEventInfo	Web application vulnerability-related risk event
EmergencyVul	SecurityEventInfo	Emergency vulnerability-related risk event
BaseLine	SecurityEventInfo	Security baseline-related risk event
AttackLogs	SecurityEventInfo	Attack detection-related risk event
EffectMachineCount	integer	Number of affected machines
EventsCount	integer	Total of number of events
WindowVul	SecurityEventInfo	Total of Windows system vulnerability events
LinuxVul	SecurityEventInfo	Total of Linux system vulnerability events
RequestId	string	The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.

Success

{
  "Response": {
    "Malware": …,
    "HostLogin": …,
    "RequestId": "…"
  }
}

Error

{
  "Response": {
    "Error": { "Code": "…", "Message": "…" },
    "RequestId": "…"
  }
}

Try it

CredentialThe key never leaves this tab — it signs the request here. The signed request goes to /api-relay/cwp.

SecretIdSecretKey

Request bodyvalid JSONPOST cwp.api3.convergecloud.com · DescribeSecurityEventsCnt

{}

Read-only. Creates nothing.