Update event rules

Updates rules associated with a specified event type.

SecuritySecretApiKey or JWT
Request
path Parameters
eventType
required
string

Type of event.

Request Body schema: application/json

Ruleset resource.

required
Array of objects (Rule)

Rules can be configured to stop subsequent rules in the event list from being executed. A rule is a configuration of an event and one or more actions.

Array
name
required
string

Name of the rule.

required
Array of objects (RuleAction) unique

Actions that execute when an event occurs.

id
string <= 50 characters

ID of the rule.

labels
Array of strings unique

Labels of the rule.

status
string (OnOff)
Default: "active"
Enum: "active" "inactive"
filter
string

Filters the collection items. This field requires a special format. Use , for multiple allowed values. Use ; for multiple fields.

For more information, see Using filter with collections.

final
boolean
Default: true

Specifies whether the rule stops subsequent rules in the event list from being executed.

Array of objects (Bind)

Binds always execute, regardless of rule based events. A bind is a configuration of an event and one or more actions.

Array
name
required
string

Name of the rule.

required
Array of objects (RuleAction) unique

Actions that execute when an event occurs.

id
string <= 50 characters

ID of the rule.

labels
Array of strings unique

Labels of the rule.

status
string (OnOff)
Default: "active"
Enum: "active" "inactive"
filter
string

Filters the collection items. This field requires a special format. Use , for multiple allowed values. Use ; for multiple fields.

For more information, see Using filter with collections.

Responses
200

Rules updated.

Response Schema: application/json
required
Array of objects (Rule)

Rules can be configured to stop subsequent rules in the event list from being executed. A rule is a configuration of an event and one or more actions.

Array
name
required
string

Name of the rule.

required
Array of objects (RuleAction) unique

Actions that execute when an event occurs.

id
string <= 50 characters

ID of the rule.

labels
Array of strings unique

Labels of the rule.

status
string (OnOff)
Default: "active"
Enum: "active" "inactive"
filter
string

Filters the collection items. This field requires a special format. Use , for multiple allowed values. Use ; for multiple fields.

For more information, see Using filter with collections.

final
boolean
Default: true

Specifies whether the rule stops subsequent rules in the event list from being executed.

version
integer

Version of the ruleset.

Array of objects (Bind)

Binds always execute, regardless of rule based events. A bind is a configuration of an event and one or more actions.

Array
name
required
string

Name of the rule.

required
Array of objects (RuleAction) unique

Actions that execute when an event occurs.

id
string <= 50 characters

ID of the rule.

labels
Array of strings unique

Labels of the rule.

status
string (OnOff)
Default: "active"
Enum: "active" "inactive"
filter
string

Filters the collection items. This field requires a special format. Use , for multiple allowed values. Use ; for multiple fields.

For more information, see Using filter with collections.

createdTime
string <date-time> (CreatedTime)

Date and time which is set automatically when the resource is created.

updatedTime
string <date-time> (UpdatedTime)

Date and time which updates automatically when the resource is updated.

Array of objects (Self) non-empty

Related links.

Array (non-empty)
href
required
string

Link URL.

rel
required
string

Type of link.

Value: "self"
401

Unauthorized access. Invalid credentials used.

403

Access forbidden.

404

Resource not found.

422

Invalid data sent.

put/events/{eventType}/rules
Request samples
application/json
{
  • "binds": [
    ],
  • "rules": [
    ]
}
Response samples
application/json
{
  • "version": 0,
  • "binds": [
    ],
  • "rules": [
    ],
  • "createdTime": "2019-08-24T14:15:22Z",
  • "updatedTime": "2019-08-24T14:15:22Z",
  • "_links": [
    ]
}