Create Rule

post

https://api.signalshq.io/rule

Create a new rule.

Args:
create_data (RuleRequest): Data for creating a new rule.
tenant_context (TenantContext): Tenant context information.
session (AsyncDbSession): Database session.

Returns:
RulesResponse: Details of the created rule.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

Pydantic model for rule requests.

Inherits:
RuleBase: The base class for rules.

name

string

required

The name of the rule.

category_id

string

enum

required

An enumeration.

Allowed:

attr_key

string

enum

required

An enumeration.

attr_data_type

string

enum

required

An enumeration.

Allowed:

group_op_id

string

enum

required

An enumeration.

Allowed:

op_id

string

enum

required

An enumeration.

attr_value

object

required

Attribute value for the rule.

score

integer

required

Score associated with the rule.

enable

boolean

required

Whether the rule is enabled or not.

Responses

Language

Credentials

Basic

base64

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200Successful Response

422Validation Error