Remediation Scanning

APIs for remediation scanning

Get or Create an RCS request

post

Get or create a remediation confirmation scanning request.

Header parameters

authorizationstringRequired

api-key

Example: {{api_key}}

x-xdr-auth-idstringRequired

api-key-id

Example: {{api_key_id}}

Body

Other propertiesanyOptional

Responses

200

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

application/json

Other propertiesanyOptional

201

A 201 response is sent for a new scan request.

application/json

400

Bad Request. Got an invalid JSON.

application/json

401

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

application/json

402

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

application/json

403

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

application/json

422

Unprocessable Entity

application/json

500

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

application/json

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

POST /public_api/v1/remediation_confirmation_scanning/requests/get_or_create/ HTTP/1.1
Host: api-{{fqdn}}
authorization: {{api_key}}
x-xdr-auth-id: {{api_key_id}}
Content-Type: application/json
Accept: */*
Content-Length: 247

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

{
  "reply": {
    "scanId": "text",
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "ANY_ADDITIONAL_PROPERTY": "anything"
}

Poll an RCS Request

post

Check the status of a remediation confirmation scan.

Header parameters

authorizationstringRequired

api-key

Example: {{api_key}}

x-xdr-auth-idstringRequired

api-key-id

Example: {{api_key_id}}

Body

Other propertiesanyOptional

Responses

200

OK

application/json

Other propertiesanyOptional

400

Bad Request. Got an invalid JSON.

application/json

401

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

application/json

402

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

application/json

403

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

application/json

422

Unprocessable Entity

application/json

500

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

application/json

post/public_api/v1/remediation_confirmation_scanning/requests/get/

POST /public_api/v1/remediation_confirmation_scanning/requests/get/ HTTP/1.1
Host: api-{{fqdn}}
authorization: {{api_key}}
x-xdr-auth-id: {{api_key_id}}
Content-Type: application/json
Accept: */*
Content-Length: 187

{
  "request_data": {
    "filters": [
      {
        "field": "id",
        "operator": "eq",
        "value": "text",
        "ANY_ADDITIONAL_PROPERTY": "anything"
      }
    ],
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "ANY_ADDITIONAL_PROPERTY": "anything"
}

{
  "reply": {
    "status": "text",
    "result": "text",
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "ANY_ADDITIONAL_PROPERTY": "anything"
}