Intelligence Requirement Categories

Intelligence Requirement (IR) categories provide greater control over how to organize your IRs. For example, you can use categories to organize IRs based on different stakeholder groups (e.g., SecOps, HR, Finance) or threat actor types (e.g., Nation State, Hacktivist). When creating or updating an IR in ThreatConnect, you can choose a category to associate with the IR.

Endpoint: /api/v3/intelRequirements/categories

Endpoint Options

Available Fields

Send the following request to retrieve a complete list of fields that may be included in responses returned from the /v3/intelRequirements/categories endpoint, which is a read-only endpoint:

OPTIONS /v3/intelRequirements/categories?show=readonly

Filter Results

When retrieving data, you can use the tql query parameter to filter results with ThreatConnect Query Language (TQL).

Send the following request to retrieve a list of valid TQL parameters you can use when including the tql query parameter in a request to the /v3/intelRequirements/categories endpoint:

OPTIONS /v3/intelRequirements/categories/tql

Schemas

Response Body

The default response returned from successful GET requests to the /v3/intelRequirements/categories endpoint includes one or more objects with the following fields:

id: <Integer> The IR category’s ID number.
name: <String> The IR category’s name.
description: <String> The IR category’s description.

Example

{
    "id": <int>,
    "name": "<string>",
    "description": "<string>"
}

Retrieve Intelligence Requirement Categories

Retrieve All Intelligence Requirement Categories

Send the following request to retrieve data for all IR categories on your ThreatConnect instance.

Request

GET /v3/intelRequirements/categories

Response

{
    "data": [
        {
            "id": 1,
            "name": "Nation State",
            "description": "IRs related to Nation State threat actors"
        },
        {
            "id": 2,
            "name": "Hacktivist",
            "description": "IRs related to hacktivists"
        }
    ],
    "count": 2,
    "status": "Success"
}

Retrieve a Specific Intelligence Requirement Category

Send a request in the following format to retrieve data for a specific IR category.

Example Request

GET /v3/intelRequirements/categories/{categoryId}

For example, the following request will retrieve data for the IR category whose ID is 1.

Request

GET /v3/intelRequirements/categories/1

Response

{
    "data": {
        "id": 1,
        "name": "Nation State",
        "description": "IRs related to Nation State threat actors"
    },
    "status": "Success"
}