STstackstorm

GET /api/v1/ruleenforcements/views

Changed on

Returns a list of all the rule enforcements.

Request

  • The document declares no server URL.
  • Auth
    • API key in header X-Auth-Token
    • or API key in header St2-Api-Key
    • or API key in query parameter x-auth-token
    • or API key in query parameter st2-api-key
    • or API key in header auth-token

Query parameters

exclude_attributesstring[]

List of attributes to exclude

include_attributesstring[]

List of attributes to include

limitinteger

List N most recent rule enforcements.

offsetinteger

Number of rule enforcements to offset

sortstring

Comma-separated list of fields to sort by

idstring[]

Entity id filter

namestring[]

Entity name filter

executionstring

Execution to filter the list.

rule_refstring

Rule ref to filter the list.

rule_idstring

Rule id to filter the list..

trigger_instancestring

Trace instance id to filter the list.

enforced_at_gtstring

Only return enforcements with enforced_at greater than the one provided. Use time in the format.

enforced_at_ltstring

Only return enforcements with enforced_at lower than the one provided. Use time in the format.

Response

List of rule enforcements

RuleEnforcementsList[] required

Changes