Opencast

System Bundle Info REST Documentation

/sysinfo
The system bundle info endpoint yields information about the running OSGi bundles of Opencast.

General Notes

Table of Contents

Read methods

Method / Path: GET /bundles/version
Description: Return the common OSGi build version and build number of all bundles matching the given prefix.
Path params: NONE
Optional (query) params: prefix(Default value=opencast): The bundle name prefixes to check. Defaults to 'opencast'.
Response formats: application/json
Status codes: 200: OK, Version structure
404: Not Found, No bundles with the given prefix
Notes:
  • Return value description: The search results as json.
Testing:
Sample: /bundles/version?prefix=opencast
Testing form (click to reveal)
Method / Path: GET /bundles/check
Description: Check if all bundles throughout the cluster have the same OSGi bundle version and build number.
Path params: NONE
Optional (query) params: prefix(Default value=opencast): The bundle name prefixes to check. Defaults to 'opencast'.
Status codes: 200: OK, true/false
404: Not Found, cannot find any bundles with the given prefix
Notes:
  • Return value description: The search results, expressed as xml or json.
Testing:
Sample: /bundles/check?prefix=opencast
Testing form (click to reveal)
Method / Path: GET /bundles/list
Description: Return a list of all running bundles on the whole cluster.
Path params: NONE
Optional (query) params: NONE
Response formats: application/json
Status codes: 200: OK, A list of bundles.
Notes:
  • Return value description: The search results, expressed as xml or json.
Testing:
Sample: /bundles/list
/sysinfo/bundles/list

Write methods

Method / Path: DELETE /bundles/host
Description: Removes the tracked bundles for a host. This is done automatically when you shut down Opencast. But this endpoint can be used to force this in case e.g. a machine got dropped. Make sure the host is actually gone! The database will be automatically rebuilt when Opencast on that host is (re)started.
Path params: NONE
Required (form) params: host: The name of the host to clear
Optional (query) params: NONE
Status codes: 204: No Content, Version structure
Notes:
  • Return value description: No data is returned.
Testing:
Sample: /bundles/host
Testing form (click to reveal)