REST API Reference
Browse all available REST API endpoints. View the request and response schemas. See the example payloads.
The REST API server runs only with an activated license. In the free tier, the server refuses to start. See What requires a license.
When FXCanvas runs with the REST API enabled, the same documentation is available at http://localhost:8080/api/v1/docs. From that page, you can make live test requests against your own instance.
The "Try it" feature in the API explorer below does not work from this public documentation site. Your browser cannot reach your local FXCanvas instance from an external HTTPS page.
To make live test requests, open the documentation from FXCanvas at http://localhost:8080/api/v1/docs. That page comes from the same origin as the API, so no browser restriction applies.