Skip to main content
Operational routes require an ECS API key with canopy:read.

​
SPA mode

Set spa to true when browser-side routing should handle paths such as /account/settings or /dashboard/projects. Leave it false when each URL should resolve to a separately uploaded file.

​
Deployment status

GET /canopy/sites/:name/status The endpoint returns recent revisions. Add ?revision_id=REVISION_ID to receive an SSE progress stream. Wait for a revision to reach succeeded before treating a deployment as ready.

​
Logs

GET /canopy/sites/:name/logs The JSON response is { "logs": [...], "next_cursor": ... }. Send Accept: text/event-stream for live logs.

​
Custom domains

Use Waymark when a site needs a custom hostname. The target resource ID is the site UUID returned by Canopy.

​
Troubleshooting