OpenRe.Stream API
Generated at from
openvibe-contracts v0.53.0 and
openvibe-sdk v0.11.0.
Server https://openre.stream. 22 routes performing 7 capabilities. OpenAPI 3.1 document.
PATCH /api/v1/destinations/{id}
Create, update, delete and test restream destinations (stream keys are write-only and sealed at rest; URLs must be rtmp/rtmps/srt with public hosts), and start or stop an output for the live session.
- Capabilities
- openre.output.write
- Visibility
- first-party
- Parameters
id(path, required)
- Request body
application/jsonopenre.output-write-request@1- Response
application/jsonopenre.output-write-result@1- Errors
- errors.problem@1 (application/problem+json)
Description
<p><strong>openre.output.write</strong> (first-party): Create, update, delete and test restream destinations (stream keys are write-only and sealed at rest; URLs must be rtmp/rtmps/srt with public hosts), and start or stop an output for the live session.</p>DELETE /api/v1/destinations/{id}
Create, update, delete and test restream destinations (stream keys are write-only and sealed at rest; URLs must be rtmp/rtmps/srt with public hosts), and start or stop an output for the live session.
- Capabilities
- openre.output.write
- Visibility
- first-party
- Parameters
id(path, required)
- Input
- openre.output-write-request@1
- Response
application/jsonopenre.output-write-result@1- Errors
- errors.problem@1 (application/problem+json)
Description
<p><strong>openre.output.write</strong> (first-party): Create, update, delete and test restream destinations (stream keys are write-only and sealed at rest; URLs must be rtmp/rtmps/srt with public hosts), and start or stop an output for the live session.</p>GET /api/v1/destinations/{id}/logs
Read restream destinations (keys masked to their last four characters), outputs with health and progress, and bounded logs.
- Capabilities
- openre.output.read
- Visibility
- first-party
- Parameters
id(path, required)
- Response
application/jsonopenre.output-read-result@1- Errors
- errors.problem@1 (application/problem+json)
Description
<p><strong>openre.output.read</strong> (first-party): Read restream destinations (keys masked to their last four characters), outputs with health and progress, and bounded logs.</p>POST /api/v1/destinations/{id}/start
Create, update, delete and test restream destinations (stream keys are write-only and sealed at rest; URLs must be rtmp/rtmps/srt with public hosts), and start or stop an output for the live session.
- Capabilities
- openre.output.write
- Visibility
- first-party
- Parameters
id(path, required)
- Request body
application/jsonopenre.output-write-request@1- Response
application/jsonopenre.output-write-result@1- Errors
- errors.problem@1 (application/problem+json)
Description
<p><strong>openre.output.write</strong> (first-party): Create, update, delete and test restream destinations (stream keys are write-only and sealed at rest; URLs must be rtmp/rtmps/srt with public hosts), and start or stop an output for the live session.</p>POST /api/v1/destinations/{id}/stop
Create, update, delete and test restream destinations (stream keys are write-only and sealed at rest; URLs must be rtmp/rtmps/srt with public hosts), and start or stop an output for the live session.
- Capabilities
- openre.output.write
- Visibility
- first-party
- Parameters
id(path, required)
- Request body
application/jsonopenre.output-write-request@1- Response
application/jsonopenre.output-write-result@1- Errors
- errors.problem@1 (application/problem+json)
Description
<p><strong>openre.output.write</strong> (first-party): Create, update, delete and test restream destinations (stream keys are write-only and sealed at rest; URLs must be rtmp/rtmps/srt with public hosts), and start or stop an output for the live session.</p>POST /api/v1/destinations/{id}/test
Create, update, delete and test restream destinations (stream keys are write-only and sealed at rest; URLs must be rtmp/rtmps/srt with public hosts), and start or stop an output for the live session.
- Capabilities
- openre.output.write
- Visibility
- first-party
- Parameters
id(path, required)
- Request body
application/jsonopenre.output-write-request@1- Response
application/jsonopenre.output-write-result@1- Errors
- errors.problem@1 (application/problem+json)
Description
<p><strong>openre.output.write</strong> (first-party): Create, update, delete and test restream destinations (stream keys are write-only and sealed at rest; URLs must be rtmp/rtmps/srt with public hosts), and start or stop an output for the live session.</p>GET /api/v1/outputs/{id}/logs
Read restream destinations (keys masked to their last four characters), outputs with health and progress, and bounded logs.
- Capabilities
- openre.output.read
- Visibility
- first-party
- Parameters
id(path, required)
- Response
application/jsonopenre.output-read-result@1- Errors
- errors.problem@1 (application/problem+json)
Description
<p><strong>openre.output.read</strong> (first-party): Read restream destinations (keys masked to their last four characters), outputs with health and progress, and bounded logs.</p>GET /api/v1/sessions
Read ingest sessions: lifecycle and transitions, worker and generation, media info, recording state and the playback descriptor; list worker generations.
- Capabilities
- openre.session.read
- Visibility
- first-party
- Response
application/jsonopenre.session-read-result@1- Errors
- errors.problem@1 (application/problem+json)
Description
<p><strong>openre.session.read</strong> (first-party): Read ingest sessions: lifecycle and transitions, worker and generation, media info, recording state and the playback descriptor; list worker generations.</p>GET /api/v1/sessions/{id}
Read ingest sessions: lifecycle and transitions, worker and generation, media info, recording state and the playback descriptor; list worker generations.
- Capabilities
- openre.session.read
- Visibility
- first-party
- Parameters
id(path, required)
- Response
application/jsonopenre.session-read-result@1- Errors
- errors.problem@1 (application/problem+json)
Description
<p><strong>openre.session.read</strong> (first-party): Read ingest sessions: lifecycle and transitions, worker and generation, media info, recording state and the playback descriptor; list worker generations.</p>POST /api/v1/sessions/{id}/end
Ask the worker that owns a session to disconnect its encoder (the session then ends normally).
- Capabilities
- openre.session.end
- Visibility
- first-party
- Parameters
id(path, required)
- Response
application/jsonopenre.session-end-result@1- Errors
- errors.problem@1 (application/problem+json)
Description
<p><strong>openre.session.end</strong> (first-party): Ask the worker that owns a session to disconnect its encoder (the session then ends normally).</p>GET /api/v1/sessions/{id}/outputs
Read restream destinations (keys masked to their last four characters), outputs with health and progress, and bounded logs.
- Capabilities
- openre.output.read
- Visibility
- first-party
- Parameters
id(path, required)
- Response
application/jsonopenre.output-read-result@1- Errors
- errors.problem@1 (application/problem+json)
Description
<p><strong>openre.output.read</strong> (first-party): Read restream destinations (keys masked to their last four characters), outputs with health and progress, and bounded logs.</p>GET /api/v1/sessions/{id}/playback
Read ingest sessions: lifecycle and transitions, worker and generation, media info, recording state and the playback descriptor; list worker generations.
- Capabilities
- openre.session.read
- Visibility
- first-party
- Parameters
id(path, required)
- Response
application/jsonopenre.session-read-result@1- Errors
- errors.problem@1 (application/problem+json)
Description
<p><strong>openre.session.read</strong> (first-party): Read ingest sessions: lifecycle and transitions, worker and generation, media info, recording state and the playback descriptor; list worker generations.</p>GET /api/v1/streams
Read stream definitions: ingest URLs, key metadata (hint, status; never a key), settings and external references.
- Capabilities
- openre.stream.read
- Visibility
- first-party
- Response
application/jsonopenre.stream-read-result@1- Errors
- errors.problem@1 (application/problem+json)
Description
<p><strong>openre.stream.read</strong> (first-party): Read stream definitions: ingest URLs, key metadata (hint, status; never a key), settings and external references. Owners read their own; a service reads every stream, or the streams of the X-OV-Subject it acts for.</p>POST /api/v1/streams
Create, update and archive stream definitions (creation issues the first ingest key, returned once).
- Capabilities
- openre.stream.write
- Visibility
- first-party
- Request body
application/jsonopenre.stream-write-request@1- Response
application/jsonopenre.stream-write-result@1- Errors
- errors.problem@1 (application/problem+json)
Description
<p><strong>openre.stream.write</strong> (first-party): Create, update and archive stream definitions (creation issues the first ingest key, returned once). Archiving is refused while a session is open.</p>GET /api/v1/streams/{id}
Read stream definitions: ingest URLs, key metadata (hint, status; never a key), settings and external references.
- Capabilities
- openre.stream.read
- Visibility
- first-party
- Parameters
id(path, required)
- Response
application/jsonopenre.stream-read-result@1- Errors
- errors.problem@1 (application/problem+json)
Description
<p><strong>openre.stream.read</strong> (first-party): Read stream definitions: ingest URLs, key metadata (hint, status; never a key), settings and external references. Owners read their own; a service reads every stream, or the streams of the X-OV-Subject it acts for.</p>PATCH /api/v1/streams/{id}
Create, update and archive stream definitions (creation issues the first ingest key, returned once).
- Capabilities
- openre.stream.write
- Visibility
- first-party
- Parameters
id(path, required)
- Request body
application/jsonopenre.stream-write-request@1- Response
application/jsonopenre.stream-write-result@1- Errors
- errors.problem@1 (application/problem+json)
Description
<p><strong>openre.stream.write</strong> (first-party): Create, update and archive stream definitions (creation issues the first ingest key, returned once). Archiving is refused while a session is open.</p>DELETE /api/v1/streams/{id}
Create, update and archive stream definitions (creation issues the first ingest key, returned once).
- Capabilities
- openre.stream.write
- Visibility
- first-party
- Parameters
id(path, required)
- Input
- openre.stream-write-request@1
- Response
application/jsonopenre.stream-write-result@1- Errors
- errors.problem@1 (application/problem+json)
Description
<p><strong>openre.stream.write</strong> (first-party): Create, update and archive stream definitions (creation issues the first ingest key, returned once). Archiving is refused while a session is open.</p>GET /api/v1/streams/{id}/destinations
Read restream destinations (keys masked to their last four characters), outputs with health and progress, and bounded logs.
- Capabilities
- openre.output.read
- Visibility
- first-party
- Parameters
id(path, required)
- Response
application/jsonopenre.output-read-result@1- Errors
- errors.problem@1 (application/problem+json)
Description
<p><strong>openre.output.read</strong> (first-party): Read restream destinations (keys masked to their last four characters), outputs with health and progress, and bounded logs.</p>POST /api/v1/streams/{id}/destinations
Create, update, delete and test restream destinations (stream keys are write-only and sealed at rest; URLs must be rtmp/rtmps/srt with public hosts), and start or stop an output for the live session.
- Capabilities
- openre.output.write
- Visibility
- first-party
- Parameters
id(path, required)
- Request body
application/jsonopenre.output-write-request@1- Response
application/jsonopenre.output-write-result@1- Errors
- errors.problem@1 (application/problem+json)
Description
<p><strong>openre.output.write</strong> (first-party): Create, update, delete and test restream destinations (stream keys are write-only and sealed at rest; URLs must be rtmp/rtmps/srt with public hosts), and start or stop an output for the live session.</p>GET /api/v1/streams/{id}/keys
Read stream definitions: ingest URLs, key metadata (hint, status; never a key), settings and external references.
- Capabilities
- openre.stream.read
- Visibility
- first-party
- Parameters
id(path, required)
- Response
application/jsonopenre.stream-read-result@1- Errors
- errors.problem@1 (application/problem+json)
Description
<p><strong>openre.stream.read</strong> (first-party): Read stream definitions: ingest URLs, key metadata (hint, status; never a key), settings and external references. Owners read their own; a service reads every stream, or the streams of the X-OV-Subject it acts for.</p>POST /api/v1/streams/{id}/keys/rotate
Rotate a stream's ingest key: a new key is issued and returned once; the old one is revoked immediately or after a grace period, and running sessions can optionally be ended.
- Capabilities
- openre.key.rotate
- Visibility
- first-party
- Parameters
id(path, required)
- Request body
application/jsonopenre.key-rotate-request@1- Response
application/jsonopenre.key-rotate-result@1- Errors
- errors.problem@1 (application/problem+json)
Description
<p><strong>openre.key.rotate</strong> (first-party): Rotate a stream's ingest key: a new key is issued and returned once; the old one is revoked immediately or after a grace period, and running sessions can optionally be ended.</p>GET /api/v1/workers
Read ingest sessions: lifecycle and transitions, worker and generation, media info, recording state and the playback descriptor; list worker generations.
- Capabilities
- openre.session.read
- Visibility
- first-party
- Response
application/jsonopenre.session-read-result@1- Errors
- errors.problem@1 (application/problem+json)