cwp — Cloud Workload Protection
cwp · 2018-02-28
DescribeVulInfoCvss
POST
Obtain vulnerability details with the CVSS version.
Wire call
Converge Cloud is RPC over HTTP. There is one path — / — and the action travels in the X-TC-Action header. The /cwp/DescribeVulInfoCvss 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: DescribeVulInfoCvss' \
-H 'X-TC-Version: 2018-02-28' \
-H 'X-TC-Timestamp: <unix-seconds>' \
-H 'X-TC-Region: luzon' \
-d '{"VulId":"<VulId>"}'Request parameters
| Field | Type | Required | Description |
|---|---|---|---|
| VulId | integer | Yes | Vulnerability ID |
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 |
|---|---|---|
| VulId | integer | Vulnerability ID |
| VulName | string | Vulnerability name |
| VulLevel | integer | Hazard level: 1-Low-risk; 2-Medium-risk; 3-High-risk; 4-Critical |
| VulType | integer | Vulnerability Classification: 1: Web-CMS Vulnerability 2: Application Vulnerabilities 4: Linux Software Vulnerabilities 5: Windows System Vulnerabilities |
| Description | string | Vulnerability Description Information |
| RepairPlan | string | Fixing solution |
| CveId | string | Vulnerability CVE ID |
| Reference | string | Reference link |
| CVSS | string | CVSS Information |
| PublicDate | string | Release date |
| CvssScore | integer | CVSS Score |
| CveInfo | string | CVSS Details |
| CvssScoreFloat | number | CVSS score, floating point type |
| Labels | string | Vulnerability Tags, Separated by Multiple Commas |
| DefenseAttackCount | integer | Number of Attacks Defended |
| SuccessFixCount | integer | Total Number of Successful Network Repairs. Returns 0 by default for unsupported auto-repair vulnerabilities. |
| FixSwitch | integer | Repair support: 0 - Neither Windows nor Linux supports for repair; 1 - Both Windows and Linux support for repair; 2 - Only Linux supports for repair; 3 - Only Windows supports for repair. |
| 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": {
"VulId": …,
"VulName": …,
"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.
Request bodyvalid JSONPOST cwp.api3.convergecloud.com · DescribeVulInfoCvss
Read-only. Creates nothing.