Attacks
On this page:
THE ATTACK OBJECT |
|
GET[base]/attacks |
|
GET[base]/attacks/{attackId} |
The Attack object
This object provides the following data about an attack registered in the system:
- attackId string
The identifier of an attack in the system.
- ipAddress string
The IP address from which the attack has been registered.
- incidents integer
The number of incidents — failed attempts to obtain a token because of invalid credentials.
- createTime string
The date and time when the object has been created.
- updateTime string
The date and time when the object has been last updated.
{
"attackId": "6006dda272f002519c3eb505",
"ipAddress": "185.155.96.184",
"incidents": 1,
"createTime": "2021-01-01T00:00:00+00:00",
"updateTime": "2021-01-01T00:00:00+00:00"
}
Get an attacks list
Use this method to obtain a list of all attacks registered in the system.
To obtain detailed information about a specified attack, use a separate method to get attack details.
Request
Header parameters:
Authorization: Bearer <token>
Query parameters:
This method supports pagination, sorting, and filtering. For details on applying the parameters, refer to the Query parameters section. Possible parameters for filtering and sorting are listed below. For values description, refer to the Attack object.
Possible values for the filter
parameter:
ipAddress
createDate
updateDate
Possible values for the sort_by
parameter:
attackId
ipAddress
createTime
(default)updateTime
GET[base]/attacks
curl --location -g --request GET 'https://your.base-url.here/attacks?limit=10&offset=0&sort_by=createTime&filter[createDate]=2021-01-01&filter[ipAddress]=185.155.96.184&filter[updateDate]=2021-01-01' \
--header 'Authorization: Bearer <token>'
Response
Body:
In case of success, the response body contains an array of Attack objects providing information about all attacks that correspond to the query parameters specified in the request.
Get attack details
Use this method to obtain detailed information about a specified attack.
To obtain a list of all attacks registered in the system, use a separate method to get a list of attacks.
Request
Header parameters:
Authorization: Bearer <token>
Path parameters:
- attackId required
The attack identifier.
GET[base]/attacks/{attackId}
curl --location --request GET 'https://your.base-url.here/attacks/60ba407d15951453e60e49f8' \
--header 'Authorization: Bearer <token>'
Response
Body:
In case of success, the response body contains an Attack object providing information about the specified attack.