Vulnerability Testing

APIs for vulnerability testing

Bulk Update Vulnerability Tests

post

Enable or disable vulnerability tests.

To view vulnerability test results, use the Get All Services or Get Service Details endpoints.

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/assets/bulk_update_vulnerability_tests/

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

{
  "request_data": {
    "test_names": [
      "text"
    ],
    "status": "enabled",
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "ANY_ADDITIONAL_PROPERTY": "anything"
}

{
  "reply": {
    "bulk_update_result": "Success",
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "ANY_ADDITIONAL_PROPERTY": "anything"
}

Get Vulnerability Tests

post

Get a complete or filtered list of vulnerability tests. Response include details about each test, including the number of services confirmed vulnerable.

To view vulnerability test results, use the Get All Services or Get Service Details endpoints.

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/assets/get_vulnerability_tests/

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

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

{
  "reply": {
    "total_count": 1,
    "result_count": 1,
    "vulnerability_tests": [
      {
        "id": "text",
        "name": "text",
        "vulnerability_ids": [
          "text"
        ],
        "description": "text",
        "status": "text",
        "vendor_names": [
          "text"
        ],
        "affected_software": [
          {
            "NAME": "text",
            "VERSION_START_INCLUDING": "text",
            "VERSION_START_EXCLUDING": "text",
            "VERSION_END_INCLUDING": "text",
            "VERSION_END_EXCLUDING": "text",
            "VENDOR": "text",
            "PRODUCT": "text",
            "VERSION": "text",
            "ANY_ADDITIONAL_PROPERTY": "anything"
          }
        ],
        "severity_score": 1,
        "cwe_ids": [
          "text"
        ],
        "epss_score": 1,
        "references": [
          "text"
        ],
        "remediation_guidance": "text",
        "first_published": 1,
        "created": 1,
        "count_vulnerable_services": 1,
        "ANY_ADDITIONAL_PROPERTY": "anything"
      }
    ],
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "ANY_ADDITIONAL_PROPERTY": "anything"
}