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.
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¶
List all services¶
-
GET
/vidispine-service
¶ Return all Vidispine services and their status and load.
Query Parameters: - stacktrace (boolean) – Return a stack trace for each service. Default is
false
Produces: - application/xml, application/json – VidispineServiceListDocument
Role: _administrator
- stacktrace (boolean) – Return a stack trace for each service. Default is
Retrieve a service¶
-
GET
/vidispine-service/service/
(service)¶ Return a specific Vidispine service and its status and load.
Query Parameters: - stacktrace (boolean) – Return a stack trace for each service. Default is
false
Produces: - application/xml, application/json – VidispineServiceListDocument
Role: _administrator
- stacktrace (boolean) – Return a stack trace for each service. Default is
Service status¶
Enable all services¶
-
PUT
/vidispine-service/enable
¶ Enables all disabled services.
Role: _administrator
Enable a service¶
-
PUT
/vidispine-service/service/
(service)/enable
¶ Enables this service if disabled.
Role: _administrator
Disable all services¶
-
PUT
/vidispine-service/disable
¶ Disables all services. No instance in the cluster will run any services.
Role: _administrator
Disable a service¶
-
PUT
/vidispine-service/service/
(service)/disable
¶ Disables this service. No instance in the cluster will run this service.
Role: _administrator
Stack trace¶
Retrieve 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