[GET] Get incident types

Modified on Tue, 11 Feb at 3:46 AM

https://api.s7risk.com

The Incident API provides well constructed high-quality, highly-tailored and scalable threat intelligence data.

`GET /incident-types`Get incident types

This endpoint gets all available incident types. The incident types returned can be filtered in scope by adding a search parameter or Category ID to your request.

HTTP Request

curl -X GET 'https://api.s7risk.com/incident-types' \
  -H 'Content-Type: application/json' \
  -H 'Authorization: Bearer {{YOUR_AUTHENTICATION_TOKEN}}' \
  -d 'search=attack' \
  -d 'category=eq:f88942c1-eadb-4b2e-b462-2bc68f38a9a2' \
  -d 'sort=icon:asc' \
  -d 'page=1' \
  -d 'pageSize=3' \
  --compressed

Headers

Name	Type	Required	Description
`Authorization`	string	✔️	Your authentication token (see the Auth API section for more information)

Query Parameters

Name	Type	Description
`search`	string	Search using the given search term
`category`	string	Filter the results by Category ID. Supports the following operators: `eq`, `neq`, `in` or `nin`.
`sort`	string	Sort the results by the given properties. Available options `name:asc` or `name:desc`, `id:asc` or `id:desc`, `severity:asc` or `severity:desc` and `icon:asc` or `icon:desc`. If no sort order is specified then results are sorted by their relevancy
`page`	int	A paginated result set. Defaults to `1`
`pageSize`	int	A limited result set. Defaults to `100`

HTTP Response

{
    "data": [
        {
            "id": "252dcf0f-b272-4c06-80b0-ae0976822c89",
            "name": "Air to Air Attack",
            "icon": "air-to-air-attack",
            "severity": "high",
            "category": {
                "id": "f88942c1-eadb-4b2e-b462-2bc68f38a9a2",
                "name": "Air",
                "colour": "#3498DB"
            }
        },
        {
            "id": "8bdac3ea-62c7-41d4-93f3-4b9989084248",
            "name": "Attack Helicopter",
            "icon": "attack-helicopter",
            "severity": "high",
            "category": {
                "id": "f88942c1-eadb-4b2e-b462-2bc68f38a9a2",
                "name": "Air",
                "colour": "#3498DB"
            }
        },
        {
            "id": "5c6aac97-df30-4759-80da-6f39b6a4d1fc",
            "name": "Drone Attack",
            "icon": "drone-attack",
            "severity": "high",
            "category": {
                "id": "f88942c1-eadb-4b2e-b462-2bc68f38a9a2",
                "name": "Air",
                "colour": "#3498DB"
            }
        }
    ]
}

Success

Code	Status	Description
200	Success	Returns a body containing all requested incident types

Errors

Code	Status	Description
401	Unauthorized	Expired or Invalid Authentication token
422	Unprocessable Entity	Incorrect or invalid search parameter