.. _rest_api:

REST API
=========

The OST REST API's support added for get entities.

Once deployed, the API should be available at ``<HOST>/ost/api/<MAJOR_VERSION>/<RESOURCE>`` and the Swagger UI at ``<HOST>/api/<MAJOR_VERSION>/ui``.
The host depends on the environment that the server is deployed to, and may include a k8s namespace - see the README for more details. 

The OST API endpoints, with the accepted requests and expected responses, are documented below:


.. openapi:: ../../openapi/openapi.json