Skip to main content
GET
/
api
/
ruleinformation
/
{id}
Retrieve a rule information
curl --request GET \
  --url http://localhost/api/api/ruleinformation/{id} \
  --header 'Authorization: Bearer <token>'
{
  "id": 123,
  "rule_title": "<string>",
  "rule_description": "<string>",
  "alert_priority_level": "<string>",
  "custom_rule_title": "<string>",
  "custom_rule_description": "<string>",
  "created_by": 123,
  "modified_by": 123
}

Documentation Index

Fetch the complete documentation index at: https://docs.cynopsis.co/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
Authorization
string
header
required

JWT token obtained from AWS Cognito or custom authentication service

Path Parameters

​
id
integer
required

A unique integer value identifying this rule details.

Response

200 - application/json

A ModelSerializer that takes an additional fields argument that controls which fields should be displayed.

​
id
integer
required
read-only
​
rule_title
string
required
read-only
​
rule_description
string
required
read-only
​
alert_priority_level
string
required
read-only
​
custom_rule_title
string
Maximum string length: 512
​
custom_rule_description
string
Maximum string length: 1024
​
created_by
integer | null
​
modified_by
integer | null