The Catch File API
CUE Zipline exposes a
catch file API at
cue-zipline/cue-print/catch
.
This API is used by the zl-catch
command, but is also
available for use by remote management applications.
The response from the API endpoint is a JSON object containing the current recording status and links that can be used to perform actions appropriate for the current state. For example: executing
curl http://localhost:12791/cue-print-zipline/cue-print/catch
will return the following if catch file recording is currently enabled:
{ "self": "http://localhost:12791/cue-print-zipline/cue-print/catch", "home": { "data": {"catch": "enabled", "status": "ok"}, "actions": [ { "name": "home", "href": "http://localhost:12791/cue-print-zipline/cue-print/catch", "rel": ["home", "status"], "method": "GET" }, { "name": "disable", "href": "http://localhost:12791/cue-print-zipline/cue-print/catch/disable", "rel": ["disable"], "method": "PUT" }, { "name": "save", "href": "http://localhost:12791/cue-print-zipline/cue-print/catch/save", "rel": ["save"], "method": "PUT" } ] } }
Note that in this case, no enable
action is offered,
since recording is already enabled.