Skip to main content
GET
/
api
/
ruleinformation
{
  "count": 123,
  "next": "http://api.example.org/accounts/?offset=400&limit=100",
  "previous": "http://api.example.org/accounts/?offset=200&limit=100",
  "results": [
    {
      "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
    }
  ]
}

Authorizations

​
Authorization
string
header
required

JWT token obtained from AWS Cognito or custom authentication service

Query Parameters

​
limit
integer

Number of results to return per page.

​
offset
integer

The initial index from which to return the results.

Response

200 - application/json
​
count
integer
required
Example:

123

​
results
object[]
required
​
next
string<uri> | null
Example:

"http://api.example.org/accounts/?offset=400&limit=100"

​
previous
string<uri> | null
Example:

"http://api.example.org/accounts/?offset=200&limit=100"