Toggle rules

POST /accounts/{account_id}/rules/{rule_id}/toggle

Sets the rule to be turned on or off

Available on: AuditGUARD AlertGUARD PremiumGUARD EliteGUARD

Path parameters

Body Required

Send true to activate a rule

  • active boolean

    Flag to set rule to be active

Responses

  • 200

    Successful operation

    Hide response attribute Show response attribute array[object]
    • message string

      Simple message describing the action taken
POST /accounts/{account_id}/rules/{rule_id}/toggle 
curl \
 -X POST https://api.clickguard.com/accounts/{account_id}/rules/{rule_id}/toggle \
 -H "X-API-KEY: $API_KEY" \
 -H "Content-Type: application/json" \
 -d '"{\n  \"active\": true\n}"'
Request example 
"{\n  \"active\": true\n}"
Request examples 
{
  "active": true
}
Response examples (200) 
"{\n  \"message\": \"Operation successful\"\n}"
Response examples (200) 
[
  {
    "message": "string"
  }
]