> ## Documentation Index
> Fetch the complete documentation index at: https://docs.blinkops.com/llms.txt
> Use this file to discover all available pages before exploring further.

# List Rules

Gets all rules configured for the system.

## Basic Parameters

<div className="integrations-table">
  | Parameter | Description                                                         |
  | --------- | ------------------------------------------------------------------- |
  | Cursor    | Specify the pagination cursor for the next page of rules.           |
  | Includes  | Whitelist of response properties to include as an array of strings. |
  | Limit     | Max number of records to return.                                    |
</div>

## Advanced Parameters

<div className="integrations-table">
  | Parameter      | Description                        |
  | -------------- | ---------------------------------- |
  | Alias          | Filter by the alias of the rule.   |
  | Correlation ID | ID to correlate multiple requests. |
  | Transaction ID | ID for a transaction.              |
</div>

## Example Output

```json theme={"dark"}
{
	"_status": {
		"status": 0,
		"code": "string"
	},
	"_meta": {
		"stats": {
			"offset": 0,
			"limit": 0,
			"total": 0
		},
		"origin": {}
	},
	"data": [
		{
			"kind": "it:rule:detection",
			"predicate": {
				"id": "b73fc7b3-af84-48b6-bb2f-f3afd115a453",
				"definition": {},
				"patterns": [
					{}
				],
				"predicates": [
					{}
				],
				"lists": [
					{}
				]
			},
			"actions": [
				[
					{
						"kind": "it:rule:action:kind:incident",
						"parameters": {
							"probability": 0.15,
							"impact": 0.1,
							"score": 0.015,
							"urgency": 0.2,
							"severity": "incident:severity:100:low"
						}
					},
					{
						"kind": "it:rule:action:kind:notification",
						"parameters": {
							"target": {
								"id": "someUUID"
							}
						}
					}
				],
				[
					{
						"kind": "it:rule:action:kind:incident",
						"parameters": {
							"probability": 0.15,
							"impact": 0.1,
							"score": 0.015,
							"urgency": 0.2,
							"severity": "incident:severity:100:low"
						}
					},
					{
						"kind": "it:rule:action:kind:notification",
						"parameters": {
							"target": {
								"id": "someUUID"
							}
						}
					}
				],
				[
					{
						"kind": "it:rule:action:kind:incident",
						"parameters": {
							"probability": 0.15,
							"impact": 0.1,
							"score": 0.015,
							"urgency": 0.2,
							"severity": "incident:severity:100:low"
						}
					},
					{
						"kind": "it:rule:action:kind:notification",
						"parameters": {
							"target": {
								"id": "someUUID"
							}
						}
					}
				],
				[
					{
						"kind": "it:rule:action:kind:incident",
						"parameters": {
							"probability": 0.15,
							"impact": 0.1,
							"score": 0.015,
							"urgency": 0.2,
							"severity": "incident:severity:100:low"
						}
					},
					{
						"kind": "it:rule:action:kind:notification",
						"parameters": {
							"target": {
								"id": "someUUID"
							}
						}
					}
				],
				[
					{
						"kind": "it:rule:action:kind:incident",
						"parameters": {
							"probability": 0.15,
							"impact": 0.1,
							"score": 0.015,
							"urgency": 0.2,
							"severity": "incident:severity:100:low"
						}
					},
					{
						"kind": "it:rule:action:kind:notification",
						"parameters": {
							"target": {
								"id": "someUUID"
							}
						}
					}
				],
				[
					{
						"kind": "it:rule:action:kind:incident",
						"parameters": {
							"probability": 0.15,
							"impact": 0.1,
							"score": 0.015,
							"urgency": 0.2,
							"severity": "incident:severity:100:low"
						}
					},
					{
						"kind": "it:rule:action:kind:notification",
						"parameters": {
							"target": {
								"id": "someUUID"
							}
						}
					}
				],
				[
					{
						"kind": "it:rule:action:kind:incident",
						"parameters": {
							"probability": 0.15,
							"impact": 0.1,
							"score": 0.015,
							"urgency": 0.2,
							"severity": "incident:severity:100:low"
						}
					},
					{
						"kind": "it:rule:action:kind:notification",
						"parameters": {
							"target": {
								"id": "someUUID"
							}
						}
					}
				],
				[
					{
						"kind": "it:rule:action:kind:incident",
						"parameters": {
							"probability": 0.15,
							"impact": 0.1,
							"score": 0.015,
							"urgency": 0.2,
							"severity": "incident:severity:100:low"
						}
					},
					{
						"kind": "it:rule:action:kind:notification",
						"parameters": {
							"target": {
								"id": "someUUID"
							}
						}
					}
				],
				[
					{
						"kind": "it:rule:action:kind:incident",
						"parameters": {
							"probability": 0.15,
							"impact": 0.1,
							"score": 0.015,
							"urgency": 0.2,
							"severity": "incident:severity:100:low"
						}
					},
					{
						"kind": "it:rule:action:kind:notification",
						"parameters": {
							"target": {
								"id": "someUUID"
							}
						}
					}
				],
				[
					{
						"kind": "it:rule:action:kind:incident",
						"parameters": {
							"probability": 0.15,
							"impact": 0.1,
							"score": 0.015,
							"urgency": 0.2,
							"severity": "incident:severity:100:low"
						}
					},
					{
						"kind": "it:rule:action:kind:notification",
						"parameters": {
							"target": {
								"id": "someUUID"
							}
						}
					}
				]
			],
			"target": {
				"defaults": [
					{
						"kind": "endpoint:agent",
						"overlay": true
					}
				],
				"realms": [
					{
						"id": "b73fc7b3-af84-48b6-bb2f-f3afd115a453",
						"overlay": true
					}
				]
			},
			"options": {
				"filter": {
					"simple": {
						"include": [
							{
								"activity.clumps.primary.item.designations": [
									"it:activity:clump:item:first",
									"it:activity:clump:item:intermediate",
									"it:activity:clump:item:last"
								]
							}
						]
					}
				}
			},
			"details": {
				"name": "USA Part Codes",
				"description": "Two-letter codes of all USA parts including states, territories and the DC"
			},
			"alias": "USA_PART_CODES",
			"iver": 319,
			"sver": "1.2.3",
			"createdAt": "2018-04-12T16:36:51.700Z",
			"createdBy": {
				"principal": {
					"id": "b73fc7b3-af84-48b6-bb2f-f3afd115a453"
				}
			},
			"updatedAt": "2018-04-12T16:36:51.700Z",
			"updatedBy": {
				"principal": {
					"id": "b73fc7b3-af84-48b6-bb2f-f3afd115a453"
				}
			},
			"tenant": 123456789,
			"extent": "tenant",
			"status": "active",
			"tags": [
				"rules",
				"windows",
				"agent"
			],
			"id": "b73fc7b3-af84-48b6-bb2f-f3afd115a453"
		}
	]
}
```

## Workflow Library Example

[List Rules with Proofpoint Itm and Send Results Via Email](https://library.blinkops.com/workflows/list-rules-with-proofpoint-itm-and-send-results-via-email)

<div className="iframe-wrapper">
  <div className="iframe-media">
    <img src="https://mintcdn.com/blinkops-2/ojHYuDeYX5FWuN8a/img/Icons/play-box.svg?fit=max&auto=format&n=ojHYuDeYX5FWuN8a&q=85&s=b8af968e71438a9499c3223c9bd29fb2" alt="Workflow Library" width="16" height="16" data-path="img/Icons/play-box.svg" />

    Preview this Workflow on desktop
  </div>

  <iframe className="iframe" src="https://library.blinkops.com/workflows/list-rules-with-proofpoint-itm-and-send-results-via-email/canvas" />
</div>