API Service

As an admin, you can view and perform below tasks using the API Service page. You can:

  • View the available list of API’s instances that are created and running.
  • Create new API instances by clicking the New API Instance + button.
  • Check the API instances listening port.
  • Start and stop existing API service instances.
  • Delete an API instance by clicking the delete icon.
  • Edit an API service port number by clicking the edit button.
  • Start an API service container by clicking the start button.
    Figure 1. Start API Service


  • Only API images that are matching and that are supported by the UI version will be available for selection.
  • Once the API Service starts, the API Service page enables the URL at which the API service is available for connections.
Figure 2. API service URL and API Service Stop Button


  • To stop the API service, select the Stop button.
  • Click the shown API Endpoint/hyperlink to access and use the API Swagger UI.
    • Refer to the External Swagger Documentation.
    • Once an API instance is activated, the API service is available with a basic Swagger UI. This allows users to interact with the API without needing to have any of the implementation logic in place.
    • The Swagger UI enables users to interact with the available API end-points and view loaded repository report results data in an interactive way after completing authentication.