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.

Request headers
authorization
String
required
api-key
Example: {{api_key}}
x-xdr-auth-id
String
required
api-key-id
Example: {{api_key_id}}
Body parameters
required
request_dataObjectrequired

A dictionary containing the API request fields. An empty dictionary returns all results.

filtersArray

An array of filter fields.

[
fieldObject (Enum)

All three of these filters must be used.

Allowed values:"attack_surface_rule_id""alert_internal_id""service_id"
operatorObject (Enum)
Allowed values:"eq""EQ"
valueString integer
]
Free-Form object
REQUEST BODY
{ "request_data": { "filters": [ { "field": "attack_surface_rule_id", "value": "", "operator": "eq" }, { "field": "attack_surface_rule_id", "value": "", "operator": "eq" }, { "field": "attack_surface_rule_id", "value": "", "operator": "eq" } ] } }
{ "request_data": { "filters": [ { "field": "attack_surface_rule_id", "operator": "EQ", "value": "string" }, { "field": "alert_internal_id", "operator": "EQ", "value": "345487" }, { "field": "service_id", "operator": "EQ", "value": "cc550f1b-68a4-123d-456e-12345678910f" } ] } }
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" : "attack_surface_rule_id", "value" : "", "operator" : "eq" }, { "field" : "attack_surface_rule_id", "value" : "", "operator" : "eq" }, { "field" : "attack_surface_rule_id", "value" : "", "operator" : "eq" } ] } }'
Responses

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

Body
replyObject
scanIdString
Free-Form object
Free-Form object
RESPONSE
{ "reply": { "scanId": "scanId_example" } }

A 201 response is sent for a new scan request.

Body
replyObject
scanIdString
Free-Form object
Free-Form object
RESPONSE
{ "reply": { "scanId": "scanId_example" } }

Bad Request. Got an invalid JSON.

Body
replyObject

The query results upon error.

Free-Form object
RESPONSE
{ "reply": {} }

Unauthorized access. An issue occurred during authentication. This can indicate an incorrect key, id, or other invalid authentication parameters.

Body
replyObject

The query results upon error.

Free-Form object
RESPONSE
{ "reply": {} }

Unauthorized access. User does not have the required license type to run this API.

Body
replyObject

The query results upon error.

Free-Form object
RESPONSE
{ "reply": {} }

Forbidden access. The provided API Key does not have the required RBAC permissions to run this API.

Body
replyObject

The query results upon error.

Free-Form object
RESPONSE
{ "reply": {} }

Unprocessable Entity

Body
codeInteger

Error code

statusString

Error name

messageString

Error message

errorsObject

Errors

RESPONSE
{ "code": 0, "status": "status_example", "message": "message_example", "errors": {} }

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

Body
replyObject

The query results upon error.

Free-Form object
RESPONSE
{ "reply": {} }