Poll an RCS Request

Cortex Xpanse REST API

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" -H "authorization: {{api_key}}" -H "x-xdr-auth-id: {{api_key_id}}" \ "https://api-}/public_api/v1/remediation_confirmation_scanning/requests/get/" \ -d ''
Request headers
authorization
required
String
api-key
Example: {{api_key}}
x-xdr-auth-id
required
String
api-key-id
Example: {{api_key_id}}
Request
Body
required
request_data
required
Object
filters
required
Array of objects
field
optional
String (Enum)
"id": Indicates that you want to filter on a specific scan ID.
Allowed values:
id
operator
optional
String (Enum)
EQ
Allowed values:
eq
value
required
String
The scan ID (string).
Responses

OK

Body
reply
required
Object
status
required
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
reply
required
The query results 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
reply
required
The query results 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
reply
required
The query results 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
reply
required
The query results upon error.
err_code
optional
String
HTTP response code.
err_msg
optional
String
Error message.
err_extra
optional
String
Additional information describing the error.

Unprocessable Entity

Body
code
optional
Integer
Error code
status
optional
String
Error name
message
optional
String
Error message
errors
optional
Object
Errors

Internal server error. A unified status for API communication type errors.

Body
reply
required
The query results upon error.
err_code
optional
String
HTTP response code.
err_msg
optional
String
Error message.
err_extra
optional
String
Additional information describing the error.