Collect Device Vulnerability Scan report from Xsoar Server

POST 
/pub/v4.0/xsoar/device/reportUpload

To let Xsoar server report back the device vulnerability scan report

Request

Query Parameters

customerid stringrequired

The customer ID to which the API call is directed

scanType stringrequired

The name of vendor that generated the device vulnerability scan report

jobid string

The Mongo Id of the scan job that initiated by customer from IoT UI portal

reportid stringrequired

The report Id generated from device scan vendor

pdfFileName stringrequired

The PDF file name generated from device scan vendor

xmlFileName stringrequired

The metadata file name generated from device scan vendor

status stringrequired

The status of the initiated scan job

message stringrequired

The message that can be passed from Xsoar server to IoT side

multipart/form-data

Body

required

reportPDF binaryrequired

The PDF file path

xml binaryrequired

The metadata file path

Responses

200

Successful Response

application/json

Schema

Schema

received string

To indicate whether the report is received from Xsoar server side or not

upload string

To indicate whether the report is uploaded and parsed by IoT side or not

Example (from schema)

{
  "received": "string",
  "upload": "string"
}

xsoarReportUploadResponse

{
  "received": "yes",
  "upload": "yes"
}

4XX

Client Error Response

application/json

Schema

Schema

code string

STATUS_CODE

msg string

GENERAL_MESSAGE

Example (from schema)

{
  "code": "string",
  "msg": "string"
}

Bad Request

{
  "code": 400,
  "msg": "Bad Request. This occurs when an HTTP request contains an invalid query string."
}

Forbidden access

{
  "code": 403,
  "msg": "Forbidden access. Either the provided API key is invalid or it does not have the required RBAC permissions to run this API."
}

Too many requests

{
  "code": 429,
  "msg": "Too many requests. The number of requests for device details for a single device exceeded the rate limit of 180 queries per minute per tenant."
}

5XX

Server Error Response

application/json

Schema

Schema

code string

STATUS_CODE

msg string

GENERAL_MESSAGE

Example (from schema)

{
  "code": "string",
  "msg": "string"
}

xsoarReportUploadResponse

{
  "code": 500,
  "msg": "Internal server error. A unified status for API communication type errors."
}

Loading...