REST API Reference

Browse all available REST API endpoints, view request/response schemas, and see example payloads.

Local Testing

When FXCanvas is running with the REST API enabled, you can also access interactive docs at http://localhost:8080/api/v1/docs — which lets you make live test requests against your running instance.

Making Test Requests

The "Try it" feature in the API explorer below will not work from this public documentation site because your browser cannot reach your local FXCanvas instance from an external HTTPS page.

To make live test requests, open the docs from FXCanvas directly at http://localhost:8080/api/v1/docs — since it's served from the same origin as the API, requests work without any browser restrictions.