Engines

Stop an engine

Stops the engine gracefully: its playlists are closed so that viewers see the stream end, after which the engine is torn down. The engine reports stopping until the teardown has completed (typically 10–20 seconds), then stopped. To skip the graceful shutdown use POST /engines/{id}/force-stop; calling this endpoint again while the engine is stopping also force stops it. An engine in error is always force stopped. The engine can only be started again once it is stopped.

post/engines/{id}/stop

Request

  • Base URL
    https://api.theo.live/v2
  • Auth
    HTTP basic

Path parameters

idstring required

Engine ID

Response

Engine stopped

Changes

No recorded changes to this operation across all 22 revisions of this API.