List site actions | Modular DS

{
  "data": [
    {
      "attributes": {
        "clean_cache": true,
        "completed_at": null,
        "created_at": "2026-09-20T09:00:00.000000Z",
        "created_by": 501,
        "is_manual": false,
        "managed_items": [
          {
            "from_version": "8.9.5",
            "name": "WooCommerce",
            "site_item_id": 301,
            "slug": "woocommerce",
            "to_version": "8.10.0",
            "type": "plugin"
          }
        ],
        "origin": "agent",
        "requires_action": true,
        "scheduled_at": null,
        "site_id": 12,
        "started_at": "2026-09-20T09:00:00.000000Z",
        "status": "requires_action",
        "target_site": {
          "id": 12,
          "slug": "shop",
          "url": "https://shop.example.com"
        },
        "type": "manager.safe_upgrade",
        "updated_at": "2026-09-20T09:05:00.000000Z"
      },
      "id": "504",
      "links": {
        "self": "{{base_url}}/api/public/v1/site-actions/504"
      },
      "type": "site-actions"
    },
    {
      "attributes": {
        "completed_at": "2026-09-19T03:04:00.000000Z",
        "created_at": "2026-09-19T03:00:00.000000Z",
        "created_by": 502,
        "origin": "schedule",
        "site_id": 13,
        "started_at": "2026-09-19T03:00:00.000000Z",
        "status": "done",
        "type": "manager.upgrade",
        "updated_at": "2026-09-19T03:04:00.000000Z"
      },
      "id": "498",
      "links": {
        "self": "{{base_url}}/api/public/v1/site-actions/498"
      },
      "type": "site-actions"
    }
  ],
  "jsonapi": {
    "version": "1.1"
  },
  "links": {
    "first": "{{base_url}}/api/public/v1/site-actions?page%5Bnumber%5D=1",
    "last": "{{base_url}}/api/public/v1/site-actions?page%5Bnumber%5D=1",
    "next": null,
    "prev": null
  },
  "meta": {
    "current_page": 1,
    "from": 1,
    "last_page": 1,
    "links": [
      {
        "active": false,
        "label": "&laquo; Previous",
        "url": null
      },
      {
        "active": true,
        "label": "1",
        "url": "{{base_url}}/api/public/v1/site-actions?page%5Bnumber%5D=1"
      },
      {
        "active": false,
        "label": "Next &raquo;",
        "url": null
      }
    ],
    "path": "{{base_url}}/api/public/v1/site-actions",
    "per_page": 15,
    "to": 2,
    "total": 2
  }
}

Every pipeline (upgrades, safe upgrades, activations, installs, syncs, backups, scans…) launched on the token’s sites, one row per action. filter[id][] follows a whole batch by the site-actions ids a write answered. Default sort: created_at descending.

Authentication

AuthorizationBearer

Personal access token created in the Modular DS dashboard; read-only tokens can only call GET endpoints.

Query parameters

filter[id][]stringOptional

Exact site action ids

filter[site][]stringOptional

filter[team][]stringOptional

filter[tags][]stringOptional

filter[type][]stringOptional

SiteActionTypeEnum values, e.g. manager.safe_upgrade, manager.upgrade, manager.install

filter[status][]stringOptional

pending | in_progress | requires_action | done | failed

filter[origin][]stringOptional

dashboard | agent | schedule | system

filter[scheduled]stringOptional

1|0: true = waiting for a future start

filter[component]stringOptional

Actions touching one component's installs

filter[s]stringOptional

sortstringOptional

created_at | updated_at | status | type, default -created_at, --prefixed for descending

page[number]stringOptional

page[size]stringOptional

Max 50, default 15

fields[site-actions]stringOptional

Sparse fieldset; activates requires_action, scheduled_at, managed_items, clean_cache, is_manual, visual_regression, target_site - none returned unless named. clean_cache/is_manual read the action’s own metadata (both on a plain connector or safe upgrade action, clean_cache only on an install, null/null otherwise). target_site is the migration’s destination site ({id, slug, url}); falls back to the origin site, or null when the destination was deleted

Sparse fieldset; activates requires_action, scheduled_at, managed_items, clean_cache, is_manual, visual_regression, target_site - none returned unless named. clean_cache/is_manual read the action's own metadata (both on a plain connector or safe upgrade action, clean_cache only on an install, null/null otherwise). target_site is the migration's destination site ({id, slug, url}); falls back to the origin site, or null when the destination was deleted

includestringOptional

site | items

Response

200 - Site actions

datalist of objectsOptional

jsonapiobjectOptional

linksobjectOptional

metaobjectOptional