API DocsRESTRule service

ListRuleVersions

Retrieves a list of rule versions for the given rule.

GET
/api/v1/rules/{ruleId}/versions

Path Parameters

ruleId
Required
string

Query Parameters

pageSizeinteger

The maximum number of Rule Versions to return. The service may return fewer than this value. If unspecified, at most 50 Rule Versions will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.

Format: "int64"

pageTokenstring

A page token, received from a previous ListRuleVersions call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ListRuleVersions must match the call that provided the page token.

filterstring

A Common Expression Language (CEL) filter string. Available fields to filter by are rule_version_id, user_notes, and change_message. For further information about how to use CELs, please refer to this guide. Optional.

curl -X GET "<API_URL>/api/v1/rules/string/versions?pageSize=0&pageToken=string&filter=string" \
  -H "Authorization: Bearer <API_KEY>"

A successful response.

{
  "ruleVersions": [
    {
      "ruleId": "string",
      "ruleVersionId": "string",
      "version": "string",
      "createdDate": "2019-08-24T14:15:22Z",
      "createdByUserId": "string",
      "versionNotes": "string",
      "generatedChangeMessage": "string",
      "deletedDate": "2019-08-24T14:15:22Z"
    }
  ],
  "nextPageToken": "string"
}

Previous

GetRuleVersion GET

Next

SearchRules POST