POST /data_classification/qid_records

Creates a new QID record.

Creates a new QID record.

Table 1. POST /data_classification/qid_records resource details
MIME Type

application/json

Table 2. POST /data_classification/qid_records request parameter details
Parameter Type Optionality Data Type MIME Type Description

fields

header

Optional

String

text/plain

Optional - Use this parameter to specify which fields you would like to get back in the response. Fields that are not named are excluded. Specify subfields in brackets and multiple fields in the same object are separated by commas.
Table 3. POST /data_classification/qid_records request body details
Parameter Data Type MIME Type Description Sample

data

Object

application/json
Required - A QID record containing the following fields:
  • log_source_type_id - Required - Number - The ID of the log source type which the QID record is created for.
  • name - Required - String - The name of the QID record.
  • description - Optional - String - The description of the QID record.
  • severity - Optional - Number - The severity of the QID record. If not provided, the severity of the corresponding low level category is used as the default value.
  • low_level_category_id - Required - Number - The low level category ID of the QID record.

{ "log_source_type_id": 199, "name": "spp_portscan: Portscan Detected", "description": "spp_portscan: Portscan Detected", "severity": 4, "low_level_category_id":1008 }
Table 4. POST /data_classification/qid_records response codes
HTTP Response Code Unique Code Description

201

The new QID record was created.

422

1005

Invalid parameter value provided for the new QID record.

500

1020

An error occurred during the attempt to create a new QID record.

Response Description

The newly created QID record containing the following fields:
  • id - Number - The ID of the QID record.
  • qid - Number - The QID of the QID record.
  • name - String - The name of the QID record.
  • description - String - The description of the QID record.
  • severity - Number - The severity of the QID record.
  • low_level_category_id - Number - The low level category ID of the QID record.
  • log_source_type_id - Number - A placeholder with null value to ensure data structure consistency among endpoints.
  • uuid - String - The uuid of the QID record.

Response Sample


{
  "id": 63998,
  "qid": 2500001, 
  "name": "spp_portscan: Portscan Detected", 
  "description": "spp_portscan: Portscan Detected",
  "severity": 4,
  "low_level_category_id": 1008,
  "log_source_type_id": null
}