API reference

Open API Reference in the sidebar, or go to /openapi. The page lists the REST operations this TermIQ serves.

REST calls use the /api/v1 prefix. On an enterprise install the gateway adds /termiq-backend in front of that prefix. Requests and responses are JSON. File uploads are JSON with base64 fields.

GET /openapi.json and GET /openapi.yaml are the OpenAPI document. GET /swagger redirects to the reference. Import either document into an OpenAPI client.

On SaaS and on-premises, Try it out attaches the token you are signed in with, and only to this TermIQ backend. An x-api-key header is accepted in place of the bearer token. Lite has no identity provider, so Try it out sends no token.

Design-writing routes answer 404 while OL_NO_DT is set. Import, catalog, and export stay available. A process started with OL_NO_UI does not serve the web UI. /openapi stays available.