Vidispine services¶
Periodic and background operations are executed internally by Vidispine services. These resources are meant for system administrators or developers that need to troubleshoot or monitor a server.
For a list of available services, see GET /vidispine-service
. The available
Vidispine services may vary from version to version and should not be considered
to be part of the stable API.
Note
This is an internal API, and may change in future versions.
Vidispine services¶
Retrieve list of Vidispine services¶
-
GET
/vidispine-service
¶ Return all Vidispine services and their status and load.
Query Parameters: - stacktrace – Return a stack trace for each service.
Produces: - application/xml, application/json – VidispineServiceListDocument
Role: _administrator
Get Vidispine service¶
-
GET
/vidispine-service/service/
(service)¶ Return a specific Vidispine service and its status and load.
Query Parameters: - stacktrace – Return a stack trace for each service.
Produces: - application/xml, application/json – VidispineServiceListDocument
Role: _administrator
Service status¶
Enable all Vidispine services¶
-
PUT
/vidispine-service/enable
¶ Enables all disabled services.
Role: _administrator
Enable a Vidispine service¶
-
PUT
/vidispine-service/service/
(service)/enable
¶ Enables this service if disabled.
Role: _administrator
Disable all Vidispine services¶
-
PUT
/vidispine-service/disable
¶ Disables all services. No instance in the cluster will run any services.
Role: _administrator
Disable a Vidispine service¶
-
PUT
/vidispine-service/service/
(service)/disable
¶ Disables this service. No instance in the cluster will run this service.
Role: _administrator
Stack trace¶
Get service stack trace¶
-
GET
/vidispine-service/stacktrace
¶ Returns a stack trace from the system.
Produces: - text/plain – A stack trace in plain text.
Role: _administrator