Skip to main content

REST API

The SDK generates an OpepenAPI specification for the plugin, including the interactive docs based on Swagger UI.

Interactive OpenAPI docs​

You can access the Swagger UI at localhost:4201/api while the plugin server is running.

To interact with the API, you must authorize using the API key you configured for the plugin.

OpenAPI specification​

In case you need to access a raw OpenAPI specification, you can find it in the following formats: