Attack Surface Rules

APIs for managing attack surface rules

Get All Attack Surface Rules

post

Get all or a subset of attack surface rules. Required License: Cortex Xpanse Expander

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/get_attack_surface_rules/

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

{
  "request_data": {
    "filters": [
      {
        "field": "attack_surface_rule_id",
        "operator": "in",
        "value": "text"
      }
    ],
    "search_from": 0,
    "search_to": 500,
    "sort": {
      "field": "created",
      "keyword": "desc",
      "ANY_ADDITIONAL_PROPERTY": "anything"
    },
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "ANY_ADDITIONAL_PROPERTY": "anything"
}

{
  "reply": {
    "total_count": 1,
    "result_count": 1,
    "attack_surface_rules": [
      {
        "attack_surface_rule_name": "text",
        "enabled_status": "text",
        "priority": "text",
        "description": "text",
        "attack_surface_rule_id": "text",
        "category": "text",
        "knowledge_base_link": "text",
        "created": 1,
        "modified": 1,
        "modified_by": "text",
        "remediation_guidance": "text",
        "asm_alert_categories": [
          "text"
        ],
        "ANY_ADDITIONAL_PROPERTY": "anything"
      }
    ],
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "ANY_ADDITIONAL_PROPERTY": "anything"
}