sync xsoar integration playbook status to IoT
POST/pub/v4.0/xsoar/device/scanDetails
sync xsoar integration playbook status
Request
Query Parameters
customerid stringrequired
The customer ID to which the API call is directed
- application/json
Body
required
scannerList arrayrequired
list of scanners imported from 3rd party integration
timestamp numberrequired
timestamp
scanType stringrequired
name of the integration type
profileList stringrequired
list of profiles
siteList array
syncScanners boolean
the option to sync the scanner list with IoT discovered scanners
Responses
- 200
- 4XX
- 5XX
Successful Response
- application/json
- Schema
- Example (from schema)
- scanDetailsResponse
Schema
received string
if IoT has received the scanner list
{
"received": "string"
}
{
"received": "yes"
}
Client Error Response
- application/json
- Schema
- Example (from schema)
- Bad Request
- Forbidden access
- Too many requests
Schema
code string
STATUS_CODE
msg string
GENERAL_MESSAGE
{
"code": "string",
"msg": "string"
}
{
"code": 400,
"msg": "Bad Request. This occurs when an HTTP request contains an invalid query string."
}
{
"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."
}
{
"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."
}
Server Error Response
- application/json
- Schema
- Example (from schema)
- scanDetailsResponse
Schema
code string
STATUS_CODE
msg string
GENERAL_MESSAGE
{
"code": "string",
"msg": "string"
}
{
"code": 500,
"msg": "Internal server error. A unified status for API communication type errors."
}
Loading...