> ## 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.

# Create Rule

Create a configuration rule.

<Note>
  External Documentation

  To learn more, visit the [Upwind documentation](https://docs.upwind.io/restapi/v1/create-custom-rule).
</Note>

## Basic Parameters

<div className="integrations-table">
  | Parameter       | Description                                                                                                                                     |
  | --------------- | ----------------------------------------------------------------------------------------------------------------------------------------------- |
  | Asset Kind      | The kind of asset the rule applies to.                                                                                                          |
  | Description     | The description of the rule.                                                                                                                    |
  | Name            | The name of the rule.                                                                                                                           |
  | Organization ID | The ID of the organization.                                                                                                                     |
  | Rego Policy     | The Rego policy used to evaluate the rule.<br /><br />Example: `is_pass(input_item) := false { input_item.public_access == true } else := true` |
  | Severity        | The severity of the item.                                                                                                                       |
</div>

## Advanced Parameters

<div className="integrations-table">
  | Parameter           | Description                                                                                          |
  | ------------------- | ---------------------------------------------------------------------------------------------------- |
  | Category            | The category of the rule.                                                                            |
  | Framework ID        | The framework ID to associate the rule with.                                                         |
  | Related Asset Kinds | A comma-separated list of asset kinds the rule applies to if the rule correlates multiple resources. |
</div>

## Example Output

```json theme={"dark"}
{
	"id": "string",
	"name": "string",
	"description": "string",
	"category": "string",
	"risk_category": "string",
	"severity": "LOW",
	"rego_policy": "string",
	"frameworks": [
		{
			"id": "string",
			"status": "ENABLED",
			"version": "string",
			"revision": "string",
			"title": "string",
			"description": "string",
			"cloud_provider": "string"
		}
	],
	"create_time": "2024-07-29T15:51:28.071Z",
	"update_time": "2024-07-29T15:51:28.071Z"
}
```

## Workflow Library Example

[Create Rule with Upwind and Send Results Via Email](https://library.blinkops.com/workflows/create-rule-with-upwind-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/create-rule-with-upwind-and-send-results-via-email/canvas" />
</div>