REST API
The REST API reference provides detailed information about the REST API endpoints available in comby. Developers can use this reference to understand the available endpoints, request and response formats, and authentication requirements. The reference is organized by domain, with each domain containing a set of related endpoints for managing specific resources.
TIP
Under the Getting Started - REST API, you can find detailed instructions on how to add custom domains and corresponding endpoints to the existing comby default REST API.
➡️ REST API (auto-generated; OpenAPI 3.1)
(That is a copy of the latest auto-generated REST API documentation using comby defaults only.)
INFO
Note that the REST API and Reference Documentation are available at runtime in the final application. The REST API is fully generated automatically. The Reference Documentation can be generated at build time using a command and is embedded as static Markdown into the final application, allowing it to be accessed through a user interface. By default endpoints are:
/docs/apifor the REST API documentation/docs/reffor the Reference documentation
An example: If your web server is running on localhost:8090, you can access the documentation at the following URL: http://localhost:8090/docs/api and http://localhost:8090/docs/ref - if using comby defaults.