List site actions

GET

https://api.modulards.com/api/public/v1/site-actions

GET

/api/public/v1/site-actions

curl https://api.modulards.com/api/public/v1/site-actions \
     -H "Authorization: Bearer <token>"

200200 - Site actions

{
  "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
  }
}

Returns the operations launched on your websites, one row per site action, newest first: updates, safe updates, installs, activations, synchronizations, backups, scans and more. Use it to follow the work a bulk request started, by filtering on the ids it returned with filter[id][], or to find what waits for you with filter[status][]=requires_action.

Authentication

AuthorizationBearer

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

Query parameters

filter[id][]stringOptional

Site action ids. Several values match any of them.

filter[site][]stringOptional

Website ids. Several values match any of them.

filter[team][]stringOptional

Team ids. Several values match actions on websites of any of these teams.

filter[tags][]stringOptional

Tag ids. Several values match actions on websites carrying any of these tags.

filter[type][]stringOptional

Action types, for example manager.safe_upgrade, manager.upgrade or manager.install. Several values match any of them.

filter[status][]stringOptional

Action states: pending, in_progress, requires_action, done or failed. Several values match any of them.

filter[origin][]stringOptional

Who started the action: dashboard, agent, schedule or system. Requests made with the API start actions with origin agent. Several values match any of them.

filter[scheduled]stringOptional

1 for actions waiting for a future start, 0 for the rest.

filter[component]stringOptional

Component id: returns the actions that touch that component's installs.

filter[s]stringOptional

Free-text search on the name, slug or address of the action's website.

sortstringOptional

Sort order: created_at, updated_at, status or type. Prefix with - for descending. Default -created_at, newest first.

page[number]stringOptional

Page to return, starting at 1. Default 1.

page[size]stringOptional

Number of site actions per page, 1 to 50. Default 15.

fields[site-actions]stringOptional

Attributes to return, comma-separated; only those are returned. These computed attributes are left out unless named: requires_action, scheduled_at, managed_items (the items the action updates or changes), clean_cache, is_manual, visual_regression (the visual comparison of a safe update, filled only for safe updates) and target_site (the destination website of a migration; otherwise the action's own website; null when that website was deleted). clean_cache and is_manual come from the action's own options and are null when the action type has none.

includestringOptional

Related records to embed, comma-separated: site embeds the website, items embeds each step of the action, with close_reason (null, stale or auto_approved: why Modular DS closed the step on its own).

Response

200 - Site actions

datalist of objectsOptional

jsonapiobjectOptional

linksobjectOptional

metaobjectOptional