Retrieve change history record of a ruleset

Retrieves the change history record of a ruleset with a specified event type. A history record is created each time rules are changed.

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 history record retrieved.

Response Schema: application/json
version
integer

Version of the ruleset.

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 Self (object) or RuleSetHistoryLink (object) or RuleSetVersionLink (object) >= 3 items

Related links.

Array (>= 3 items)
Any of:
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/history/{version}
Request samples
// get version #2 details for this event ID
const history = await api.events.getRulesVersionNumber({eventType: 'risk-score-changed', version: 2});
// the history exposes the version number and its `createdTime`
console.log(history.fields.createdTime);
Response samples
application/json
{
  • "version": 0,
  • "createdTime": "2019-08-24T14:15:22Z",
  • "updatedTime": "2019-08-24T14:15:22Z",
  • "_links": [
    ]
}