Get or Create an RCS request

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" : "attack_surface_rule_id",
      "value" : "",
      "operator" : "EQ"
    }, {
      "field" : "attack_surface_rule_id",
      "value" : "",
      "operator" : "EQ"
    }, {
      "field" : "attack_surface_rule_id",
      "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

All three filters must be included in the request.

attack_surface_rule_id -- EQ -- string
alert_internal_id -- EQ -- integer
service_id -- EQ -- string

Example:

{"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"}]}}

request_data

required

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

filters

required

Array

An array of filter fields.

field

required

String (Enum)

All three of these filters must be used.

Allowed values:

attack_surface_rule_id

alert_internal_id

service_id

operator

required

String (Enum)

Case sensitive. Value must be EQ.

Allowed values:

value

required

Object

Responses

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

Body

required

Object

scanId

optional

String

A 201 response is sent for a new scan request.

Body

required

Object

scanId

optional

String

Bad Request. Got an invalid JSON.

Body

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

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

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

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

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.