> For clean Markdown of any page, append .md to the page URL. > For a complete documentation index, see https://api.docs.modulards.com/llms.txt. > For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://api.docs.modulards.com/_mcp/server. # Show site action GET https://api.modulards.com/api/public/v1/site-actions/{siteAction} 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. Reference: https://api.docs.modulards.com/modular-ds-public-api/website-actions/show-site-action ## Authentication - `Authorization` header (bearer token, required) — Personal access token created in the Modular DS dashboard; read-only tokens can only call GET endpoints. ## Request ### Path parameters - `siteAction` (string, required) ### Query parameters - `include` (string, optional) - `fields[site-actions]` (string, optional) — 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 200 - Site action - `data` (object, optional) - `attributes` (object, optional) - `clean_cache` (boolean, optional) - `completed_at` (any, optional, nullable) - `created_at` (string, optional) - `created_by` (double, optional) - `is_manual` (boolean, optional) - `managed_items` (list of object, optional) - `from_version` (string, optional) - `name` (string, optional) - `site_item_id` (double, optional) - `slug` (string, optional) - `to_version` (string, optional) - `type` (string, optional) - `origin` (string, optional) - `requires_action` (boolean, optional) - `scheduled_at` (any, optional, nullable) - `site_id` (double, optional) - `started_at` (string, optional) - `status` (string, optional) - `target_site` (object, optional) - `id` (double, optional) - `slug` (string, optional) - `url` (string, optional) - `type` (string, optional) - `updated_at` (string, optional) - `visual_regression` (object, optional) - `change_percentage` (double, optional) - `screenshots` (object, optional) - `after` (string, optional) - `before` (string, optional) - `diff` (string, optional) - `success_path` (string, optional) - `threshold` (double, optional) - `id` (string, optional) - `links` (object, optional) - `self` (string, optional) - `type` (string, optional) - `jsonapi` (object, optional) - `version` (string, optional) ## Examples **Response** ```json { "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" } } ``` **SDK Code** ```python 200 - Site action import requests url = "https://api.modulards.com/api/public/v1/site-actions/siteAction" headers = {"Authorization": "Bearer "} response = requests.get(url, headers=headers) print(response.json()) ``` ```javascript 200 - Site action const url = 'https://api.modulards.com/api/public/v1/site-actions/siteAction'; const options = {method: 'GET', headers: {Authorization: 'Bearer '}}; try { const response = await fetch(url, options); const data = await response.json(); console.log(data); } catch (error) { console.error(error); } ``` ```go 200 - Site action package main import ( "fmt" "net/http" "io" ) func main() { url := "https://api.modulards.com/api/public/v1/site-actions/siteAction" req, _ := http.NewRequest("GET", url, nil) req.Header.Add("Authorization", "Bearer ") res, _ := http.DefaultClient.Do(req) defer res.Body.Close() body, _ := io.ReadAll(res.Body) fmt.Println(res) fmt.Println(string(body)) } ``` ```ruby 200 - Site action require 'uri' require 'net/http' url = URI("https://api.modulards.com/api/public/v1/site-actions/siteAction") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true request = Net::HTTP::Get.new(url) request["Authorization"] = 'Bearer ' response = http.request(request) puts response.read_body ``` ```java 200 - Site action import com.mashape.unirest.http.HttpResponse; import com.mashape.unirest.http.Unirest; HttpResponse response = Unirest.get("https://api.modulards.com/api/public/v1/site-actions/siteAction") .header("Authorization", "Bearer ") .asString(); ``` ```php 200 - Site action request('GET', 'https://api.modulards.com/api/public/v1/site-actions/siteAction', [ 'headers' => [ 'Authorization' => 'Bearer ', ], ]); echo $response->getBody(); ``` ```csharp 200 - Site action using RestSharp; var client = new RestClient("https://api.modulards.com/api/public/v1/site-actions/siteAction"); var request = new RestRequest(Method.GET); request.AddHeader("Authorization", "Bearer "); IRestResponse response = client.Execute(request); ``` ```swift 200 - Site action import Foundation let headers = ["Authorization": "Bearer "] let request = NSMutableURLRequest(url: NSURL(string: "https://api.modulards.com/api/public/v1/site-actions/siteAction")! as URL, cachePolicy: .useProtocolCachePolicy, timeoutInterval: 10.0) request.httpMethod = "GET" request.allHTTPHeaderFields = headers let session = URLSession.shared let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in if (error != nil) { print(error as Any) } else { let httpResponse = response as? HTTPURLResponse print(httpResponse) } }) dataTask.resume() ```