Retrieve a site action

GET

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

GET

/api/public/v1/site-actions/:siteAction

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

200200 - Site action

{
  "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": "api",
      "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",
      "visual_regression": {
        "change_percentage": 1.2,
        "screenshot_delay": 30,
        "screenshots": {
          "after": "https://cdn.modulards.com/safe-upgrade/504/after.png?signature=abc",
          "before": "https://cdn.modulards.com/safe-upgrade/504/before.png?signature=abc",
          "diff": "https://cdn.modulards.com/safe-upgrade/504/diff.png?signature=abc"
        },
        "success_path": "/",
        "threshold": 5
      }
    },
    "id": "504",
    "links": {
      "self": "{{base_url}}/api/public/v1/site-actions/504"
    },
    "type": "site-actions"
  },
  "jsonapi": {
    "version": "1.1"
  }
}

Returns one site action with its details. Add include=items to see each step it goes through, and fields[site-actions] for the details a listing leaves out.

Only include and fields apply: filter, sort and page are ignored.

Errors

404: the site action does not exist, or it is closed (done or failed) and its last activity is outside your plan’s history window. Open site actions are always found.

Authentication

AuthorizationBearer

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

Path parameters

siteActionstringRequired

Query parameters

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).

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: change_percentage, the percentage of visual change found; threshold, the highest percentage accepted; success_path, the page compared; screenshot_delay, the seconds the after screenshot waited once the update finished; and screenshots, signed URLs of the before, after and diff images) 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.

Response

200 - Site action

dataobjectOptional

jsonapiobjectOptional