Get or Create an RCS request

Cortex Xpanse REST API

post /public_api/v1/remediation_confirmation_scanning/requests/get_or_create/

Get or create a remediation confirmation scanning request.

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_or_create/" \ -d '{ "request_data" : { "filters" : [ { "field" : "service_id", "value" : "RemediationScanFilterCondition_value", "operator" : "eq" }, { "field" : "service_id", "value" : "RemediationScanFilterCondition_value", "operator" : "eq" }, { "field" : "service_id", "value" : "RemediationScanFilterCondition_value", "operator" : "eq" } ] } }'
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
A dictionary containing the API request fields. An empty dictionary returns all results.
filters
required
Array of objects
An array of filter fields.
field
optional
String (Enum)

Field options:

  • alert_internal_id
  • attack_surface_rule_id
  • service_id
Allowed values:
service_id
attack_surface_rule_id
alert_internal_id
operator
optional
String (Enum)

eq

  • alert_id — int
  • attack_surface_rule_id — string
  • service_id — string
Allowed values:
eq
value
required
alert_id — int attack_surface_rule_id — string service_id — string
Responses

A 200 response is returned for a scan that already exists.

Body
reply
required
Object
scanId
optional
String

A 201 response is sent for a new scan request.

Body
reply
required
Object
scanId
optional
String

Bad Request. Got an invalid JSON.

Body
reply
required
Object
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
Object
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
Object
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
Object
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
Object
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.