Retrieve a version of a ruleset

Retrieves a version of a ruleset with a specified event type. A new version is created each time you change a rule.

SecuritySecretApiKey or JWT
Request
path Parameters
eventType
required
string

Type of event.

version
required
integer >= 1

Version of the ruleset.

To retrieve the full related object instead of the ID, expand the response. For more information, see Expand to include embedded objects.

query Parameters
fields
string

Limits the returned fields to the specified list, each field separated by a comma. The ID value is always returned.

expand
string

Expands a request to include embedded objects within the _embedded property of the response. This field accepts a comma-separated list of objects.

For more information, see Expand to include embedded objects.

Responses
200

Ruleset version retrieved.

Response Schema: application/json
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.

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.

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.

get/events/{eventType}/rules/versions/{version}
Request samples
// get version #2 for this event ID
const version = await api.events.getRulesVersionDetail({eventType: 'risk-score-changed', version: 2});
// the version exposes the ruleset 
console.log(version.fields.rules);
Response samples
application/json
{
  • "version": 0,
  • "binds": [
    ],
  • "rules": [
    ],
  • "createdTime": "2019-08-24T14:15:22Z",
  • "updatedTime": "2019-08-24T14:15:22Z",
  • "_links": [
    ]
}