post
/public_api/v1/remediation_confirmation_scanning/requests/get
Check the status of a remediation confirmation scan.
CURL
curl -X POST \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
"https://api-yourfqdn/public_api/v1/remediation_confirmation_scanning/requests/get" \
-d '{
"request_data" : {
"filters" : {
"field" : "field",
"value" : "value",
"operator" : "operator"
}
}
}'
Request
Body
optional
request_data
required
filters
optional
field
optional
String
"id": Indicates that you want to filter on a specific scan ID.
operator
optional
String
EQ
value
optional
String
The scan ID (string).
Responses
OK
Body
reply
optional
status
optional
String
Possible values are:
- IN_PROGRESS
- FAILED_TIMEOUT
- FAILED_ERROR
- SUCCESS
result
optional
String
If the status equals "SUCCESS", then possible result values are:
- REMEDIATED
- UNREMEDIATED
Bad Request. Got an invalid JSON.
Body
The query result upon error.
err_code
optional
String
HTTP response code.
err_msg
optional
String
Error message.
err_extra
optional
String
Additional information describing the error.
Unauthorized access. An issue occurred during authentication. This can indicate an incorrect key, id, or other invalid authentication parameters.
Body
The query result upon error.
err_code
optional
String
HTTP response code.
err_msg
optional
String
Error message.
err_extra
optional
String
Additional information describing the error.
Unauthorized access. User does not have the required license type to run this API.
Body
The query result upon error.
err_code
optional
String
HTTP response code.
err_msg
optional
String
Error message.
err_extra
optional
String
Additional information describing the error.
Forbidden access. The provided API Key does not have the required RBAC permissions to run this API.
Body
The query result upon error.
err_code
optional
String
HTTP response code.
err_msg
optional
String
Error message.
err_extra
optional
String
Additional information describing the error.
Internal server error. A unified status for API communication type errors.
Body
The query result upon error.
err_code
optional
String
HTTP response code.
err_msg
optional
String
Error message.
err_extra
optional
String
Additional information describing the error.