Retrieve change history of a ruleset

Retrieves the change history of a ruleset with a specified event type. All ruleset changes are recorded in the change history.

SecuritySecretApiKey or JWT
Request
path Parameters
eventType
required
string

Type of event.

query Parameters
limit
integer [ 0 .. 1000 ]

Limits the number of collection items to be returned.

offset
integer >= 0

Specifies the starting point within the collection of items to be returned.

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.

q
string

Use this field to perform a partial search of text fields.

sort
Array of strings

Sorts and orders the collection of items. To sort in descending order, prefix with -.

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

Response Headers
Pagination-Total
integer

Total number of items.

Example: 332
Pagination-Limit
integer

Maximum number of items per page.

Example: 100
Pagination-Offset
integer

Specifies the starting point within the collection of resource results. For example, a request with limit=20 retrieves and displays the first 20 results on a page. A following request with limit=20 and offset=20, retrieves the next page of 20 results.

Example: 2
Response Schema: application/json
Array
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
Request samples
// get the latest 20 versions for this event ID
const history = await api.events.getRulesVersionNumber({eventType: 'risk-score-changed', limit: 20});
// each item exposes the version and `createdTime`
history.items.forEach(edit => console.log(edit.fields.version));
Response samples
application/json
[
  • {
    }
]