Home
Eliza Margaretha edited this page Apr 4, 2023
·
29 revisions
Welcome to Kustvakt Wiki!
To install and run Kustvakt, please read the description in the main page or readme.
All Kustvakt web-services return responses in JSON. The services are listed on the menu on the left.
Kustvakt maintains API versioning by including the API version in the service URI. The root service URI with API version has the following format:
http://[host]:[port]/api/[version]
Default
http://localhost:8089/api/v1.0
Host, port and version can be defined in kustvakt.conf.
Example
server.port=8089 server.host=localhost current.api.version=v1.0
Kustvakt can support multiple API versions. In the config file, these versions must be separated by an empty space.
supported.api.version=v1.0 v0.1
In an IDE, you can run KustvaktLiteServer or KustvaktServer as a normal Java application.
- OAuth2 client registration
- OAuth2 client info
- OAuth2 client deregistration
- OAuth2 client secret reset
- Plugin registration
- Plugin list (Marketplace)
- Plugin installation
- Plugin uninstallation
- Installed plugin list
- User group creation
- User group deletion
- User group list
- Member invitation
- Member deletion
- Approval of member invitation
- Rejection of member invitation
- Member role management
- Virtual corpus creation and update
- Virtual corpus deletion
- Virtual corpus list
- Virtual corpus retrieval
- Virtual corpus statistics
- Virtual corpus statistics with KoralQuery