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" \
"https://api-yourfqdn/public_api/v1/remediation_confirmation_scanning/requests/get_or_create" \
 -d '{
  "request_data" : {
    "filters" : [ {
      "field" : "field",
      "value" : "value",
      "operator" : "operator"
    }, {
      "field" : "field",
      "value" : "value",
      "operator" : "operator"
    } ]
  }
}'
  

Request

Body

optional

Example:

{"request_data":{"filters":[{"field":"alert_internal_id","operator":"EQ","value":"int"},{"field":"attack_surface_rule_id","operator":"EQ","value":"string"},{"field":"service_id","operator":"EQ","value":"uuid4"}]}}

request_data

required

A dictionary containing the API request fields.

An empty dictionary returns all results.

filters

optional

Array

An array of filter fields.

field

optional

String

Field options:

alert_internal_id
attack_surface_rule_id
service_id

operator

optional

String

alert_id — int
attack_surface_rule_id — string
service_id — string

value

optional

String

alert_id — int attack_surface_rule_id — string service_id — string

Responses

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

Body

optional

scanId

optional

String

A 201 response is sent for a new scan request.

Body

optional

scanId

optional

String

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.