Contents
On this page

List Snapshots - Plugixa Advanced User Role Editor

GET /plugixa-aure/v1/snapshots

The most recent restore points, newest first. A restore point holds every role and the people a change touched, as they were just before it.

Needs the Edit roles permission: plugixa_aure_edit_roles.

Request

GET https://your-site.example/wp-json/plugixa-aure/v1/snapshots?per_page=20

Query parameters

Name Type Default Description
per_page integer 50 How many to return, 1 to 200. There is no page: older points are out of reach of this route.

For the same points with what each change did, use List History.

Responses

200 OK. data is the list.

{
  "success": true,
  "data": [
    {
      "id": 42,
      "createdAt": "2026-11-12 09:30:00",
      "actorId": 1,
      "kind": "auto",
      "label": "",
      "operation": "changes.apply",
      "target": "role:editor,user:12",
      "size": 18342,
      "actor": "Sam Carter"
    },
    {
      "id": 41,
      "createdAt": "2026-11-11 16:02:10",
      "actorId": 1,
      "kind": "manual",
      "label": "Before the shop launch",
      "operation": "snapshot.manual",
      "target": "",
      "size": 18120,
      "actor": "Sam Carter"
    }
  ]
}
Field Type Meaning
data[].id integer The restore point’s id
data[].createdAt string UTC datetime, YYYY-MM-DD HH:MM:SS
data[].actorId integer Who caused it. 0 when nobody was signed in
data[].actor string Their display name. Empty when unknown
data[].kind string auto (before a change), manual, activation (before the plugin was first installed) or restore (before a restore)
data[].label string A label, for manual and some automatic points
data[].operation string The change that caused it, such as changes.apply, role.capabilities or snapshot.manual
data[].target string What it was about: a role slug, an account id, a list such as role:editor,user:12, or a restore point id
data[].size integer Size of the stored roles, in bytes

Automatic points beyond the retention set in Settings are pruned. Manual, activation and restore points are kept until you delete them.

Errors

Plus the errors every endpoint can return.

Examples

curl -s "https://your-site.example/wp-json/plugixa-aure/v1/snapshots?per_page=20" \
  -u "admin:$WP_APP_PASSWORD"

<?php
$query = http_build_query([
    'per_page' => '20',
]);
$ch = curl_init('https://your-site.example/wp-json/plugixa-aure/v1/snapshots?' . $query);
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 query = new URLSearchParams({ per_page: '20' });
const response = await fetch(`https://your-site.example/wp-json/plugixa-aure/v1/snapshots?${query}`, {
  headers: {
    'Authorization': 'Basic ' + btoa(`admin:${process.env.WP_APP_PASSWORD}`),
  },
});
const { data } = await response.json();

Quick Links

Share