Contents
On this page

Get Alert Rule - Plugixa Activity Log

GET /plugixa-activity-log/v1/rules/{id}

Read one alert rule.

Needs settings access (see who can call what). Needs Plugixa Activity Log Pro, with the Alert rules module on under Plugixa Activity Log -> Monitors.

Request

GET https://your-site.example/wp-json/plugixa-activity-log/v1/rules/4

Path parameters

Name Type Description
id integer The rule’s id

Responses

200 OK. data is the rule.

{
  "success": true,
  "data": {
    "id": 4,
    "name": "Administrator sign-ins from outside the office",
    "enabled": true,
    "conditions": {
      "codes": [],
      "groups": ["authentication"],
      "min_severity": "medium",
      "severities": [],
      "user_roles": ["administrator"],
      "user_ids": [],
      "ips": ["203.0.113.0/24"],
      "object_types": [],
      "search": ""
    },
    "channels": [
      { "type": "email", "target": "security@example.com", "secret": "", "has_secret": false },
      { "type": "webhook", "target": "https://hooks.example.com/activity", "secret": "••••cret", "has_secret": true }
    ],
    "throttle_minutes": 15,
    "created_by": 1,
    "created_at": "2026-11-12 09:30:00",
    "modified_at": "2026-11-12 09:30:00"
  }
}
Field Type Meaning
data.enabled boolean Whether the rule is checked against new events
data.conditions object What an event must match. Every key is always present; an empty one does not narrow
data.channels[].secret string Masked: four dots and the last four characters. Send it back unchanged to keep the secret
data.channels[].has_secret boolean Whether a signing secret is stored
data.throttle_minutes integer 0 sends every match
data.modified_at string UTC datetime of the last change

The fields are described in full on List Alert Rules.

Errors

Status Code When
404 plugixa_activity_log_not_found No rule with that id.

Plus the errors every endpoint can return.

Examples

curl -s "https://your-site.example/wp-json/plugixa-activity-log/v1/rules/4" \
  -u "admin:$WP_APP_PASSWORD"

<?php
$ch = curl_init('https://your-site.example/wp-json/plugixa-activity-log/v1/rules/4');
curl_setopt_array($ch, [
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_USERPWD        => 'admin:' . getenv('WP_APP_PASSWORD'),
]);
$response = json_decode(curl_exec($ch), true);
curl_close($ch);

const auth = Buffer.from(`admin:${process.env.WP_APP_PASSWORD}`).toString('base64');
const response = await fetch('https://your-site.example/wp-json/plugixa-activity-log/v1/rules/4', {
  headers: {
    'Authorization': `Basic ${auth}`,
  },
});
const { data } = await response.json();

Quick Links

Share