Attacks Management API

The Attacks Management API provides comprehensive API endpoints for managing attack information. This API enables users to list ongoing attacks and report false positives and false negatives

Authentication

Check the authentication page to see the available options.

Access and authentication

Report false positive

post

Report a threat as a false positive with a specified reason

Authorizations

OAuth2PasswordBearerApiKey

OAuth2passwordRequired

Token URL:

Body

application/json

attack_idintegerRequired

protected_asset_idintegerRequired

reason_idintegerRequired

commentany ofOptional

stringOptional

or

nullOptional

Responses

200

Successful Response

application/json

statusstringOptionalDefault: success

codeintegerOptionalDefault: 200

422

Validation Error

application/json

post

/v2/assets/false-positive

HTTPcURLJavaScriptPython

POST /v2/assets/false-positive HTTP/1.1
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 69

{
  "attack_id": 1,
  "protected_asset_id": 1,
  "reason_id": 1,
  "comment": "text"
}

{
  "status": "success",
  "code": 200
}

Get false positive reasons

get

Retrieve available reasons for reporting false positives

Authorizations

OAuth2PasswordBearerApiKey

OAuth2passwordRequired

Token URL:

Responses

200

Successful Response

application/json

idintegerRequired

reasonstringRequired

get

/v2/assets/false-positive/reasons

HTTPcURLJavaScriptPython

GET /v2/assets/false-positive/reasons HTTP/1.1
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

200

Successful Response

[
  {
    "id": 1,
    "reason": "text"
  }
]

Report false negative

post

Report a threat as a false negative (wrongly classified)

Authorizations

OAuth2PasswordBearerApiKey

OAuth2passwordRequired

Token URL:

Body

application/json

attack_idintegerRequired

protected_asset_idintegerRequired

commentstringRequired

Responses

200

Successful Response

application/json

statusstringOptionalDefault: success

codeintegerOptionalDefault: 200

422

Validation Error

application/json

post

/v2/assets/false-negative

HTTPcURLJavaScriptPython

POST /v2/assets/false-negative HTTP/1.1
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 55

{
  "attack_id": 1,
  "protected_asset_id": 1,
  "comment": "text"
}

{
  "status": "success",
  "code": 200
}