Show 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": "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",
      "visual_regression": {
        "change_percentage": 1.2,
        "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"
  }
}

One action by id. Only include and fields apply (filter/sort/page answer 422). visual_regression is populated only for a manager.safe_upgrade action; null otherwise.\n\n- 404: the id does not exist or is not reachable from the token’s organization.

One action by id. Only `include` and `fields` apply (`filter`/`sort`/`page` answer 422). `visual_regression` is populated only for a `manager.safe_upgrade` action; `null` otherwise.\n\n- **404**: the id does not exist or is not reachable from the token's organization.

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

fields[site-actions]stringOptional

Any subset. 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

Any subset. 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

Response

200 - Site action

dataobjectOptional

jsonapiobjectOptional