Detection Rule

Get Detection Rule

Endpoint to retrieve a single Detection Rule by ID

post/detection-rule/{id}/get-item

Request

Path parameters

idstring uuid required

ID of the Detection Rule to retrieve

Request body

Example request

{
  "select": {
    "_id": true,
    "createdAt": true,
    "updatedAt": true,
    "name": true,
    "groupByField": true,
    "distinctCountField": true
  }
}

Response

Successful response

Example response

{
  "data": {
    "_id": "123e4567-e89b-12d3-a456-426614174000",
    "createdAt": {
      "_type": "DateTime",
      "value": "2023-10-01T12:00:00Z"
    },
    "updatedAt": {
      "_type": "DateTime",
      "value": "2023-10-01T12:00:00Z"
    },
    "deletedAt": {
      "_type": "DateTime",
      "value": "2023-10-01T12:00:00Z"
    },
    "version": 42,
    "projectId": "123e4567-e89b-12d3-a456-426614174000",
    "name": "Example short text",
    "description": "This is an example of longer text content that might be stored in this field.",
    "sigmaRuleYaml": "This is an example of very long text content that might be stored in this field. It can contain a lot of information, such as detailed descriptions, comments, or any other lengthy text data that needs to be stored in the database.",
    "isEnabled": true,
    "evaluationIntervalInMinutes": 42,
    "isRealTime": true,
    "groupByField": "Example short text",
    "distinctCountField": "Example short text",
    "matchCountThreshold": 42,
    "shouldCreateAlert": true,
    "shouldWriteDetectionFinding": true,
    "shouldCreateIncident": true,
    "shouldCreateCase": true,
    "riskScore": 42,
    "alertSeverityId": "123e4567-e89b-12d3-a456-426614174000",
    "incidentSeverityId": "123e4567-e89b-12d3-a456-426614174000",
    "lastEvaluatedAt": {
      "_type": "DateTime",
      "value": "2023-10-01T12:00:00Z"
    },
    "lastMatchAt": {
      "_type": "DateTime",
      "value": "2023-10-01T12:00:00Z"
    },
    "lastError": "This is an example of very long text content that might be stored in this field. It can contain a lot of information, such as detailed descriptions, comments, or any other lengthy text data that needs to be stored in the database.",
    "createdByUserId": "123e4567-e89b-12d3-a456-426614174000",
    "deletedByUserId": "123e4567-e89b-12d3-a456-426614174000"
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.