Create Rule - BlinkOps Documentation

Basic Parameters
Advanced Parameters
Example Output
Workflow Library Example

Create a configuration rule.

External DocumentationTo learn more, visit the Upwind documentation.

Basic Parameters

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. Example: `is_pass(input_item) := false { input_item.public_access == true } else := true`
Severity	The severity of the item.

Advanced Parameters

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.

Example Output

{
	"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"
}