Tells whether the rule with the given ruleId is enabled or not.

Request specification

  • Method: GET
  • URL: /rules/{ruleId}/enabled
  • Call parameters:
    • ruleId: the id of the rule, as returned by Rule.create.

Example Request

  • Request URL:
  • Request headers: X-Api-Key: aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee
  • Request method: GET

Example Response

  • HTTP status: 200 OK
  • Response body:
    { "enabled": true}

Error summary

  • 200: success.
  • 401: Api key not provided or invalid.
  • 404: given rule does not exist.
Back to top