cwp · 2018-02-28

ExportVulList

POST

Export the vulnerability list.

Wire call

Converge Cloud is RPC over HTTP. There is one path — / — and the action travels in the X-TC-Action header. The /cwp/ExportVulList 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: ExportVulList' \
  -H 'X-TC-Version: 2018-02-28' \
  -H 'X-TC-Timestamp: <unix-seconds>' \
  -H 'X-TC-Region: luzon' \
  -d '{}'

Request parameters

Field	Type	Required	Description
Filters	Filter[]	—	Filter criteria
IfDetail	integer	—	Whether to export details: 1 - yes; 0 - no

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
DownloadUrl	string	Download URL of the exported file (deprecated)
TaskId	string	ID of the exported file, which can be downloaded using the ExportTasks API.
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": {
    "DownloadUrl": …,
    "TaskId": …,
    "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 · ExportVulList

{}

This action changes resources in my own account and may create a charge. I understand.

What failure looks like

Example error responses for this action. Match on Code.

Recorded error 1

{
  "Response": {
    "RequestId": "f4a658d5-465c-3407-44c8-b271b3927c76",
    "Error": {
      "Code": "InvalidParameter",
      "Message": "[Type 3002] : Additional property Limit is not allowed; : Additional property Offset is not allowed; "
    }
  }
}