Restreamer
Search…
Core API
Take advantage of an FFmpeg REST API for fast and easy video application development.
The Core of datarhei Restreamer is free and open source. Extend datarhei Restreamer according to your needs. Flexible video processing with FFMpeg Media Framework is made easy with an API. Create your video streaming and management platform with datarhei Core.
| 100% FFmpeg media framework inside | JSON REST-API (Swagger documented) | datarhei Core in Go | GraphQL
https://github.com/datarhei/core
github.com
datarhei Core on GitHub

API

API version and build info in case auth is valid or not required. If auth is required, just the name field is populated. https://demo.datarhei.com/api/swagger/index.html​
get
https:///
/api
API version and build infos

GraphQL

Oops, something is missing.
We could not find the original source to display this content.
get
https:///
/api/graph
Load GraphQL playground

Login

Oops, something is missing.
We could not find the original source to display this content.
Oops, something is missing.
We could not find the original source to display this content.

Swagger

Oops, something is missing.
We could not find the original source to display this content.

Config

Oops, something is missing.
We could not find the original source to display this content.
Oops, something is missing.
We could not find the original source to display this content.
Oops, something is missing.
We could not find the original source to display this content.
Oops, something is missing.
We could not find the original source to display this content.

Disk filesystem

Oops, something is missing.
We could not find the original source to display this content.
Oops, something is missing.
We could not find the original source to display this content.
Oops, something is missing.
We could not find the original source to display this content.
Oops, something is missing.
We could not find the original source to display this content.

In-Memory filesystem

Oops, something is missing.
We could not find the original source to display this content.
get
https:///
/api/v3/fs/mem/{path}
Fetch a file from the memory filesystem
patch
https:///
/api/v3/fs/mem/{path}
Create a link to a file in the memory filesystem
put
https:///
/api/v3/fs/mem/{path}
Add a file to the memory filesystem
delete
https:///
/api/v3/fs/mem/{path}
Remove a file from the memory filesystem

Logging

get
https:///
/api/v3/log
Application log

Metadata

Oops, something is missing.
We could not find the original source to display this content.
put
https:///
/api/v3/metadata/{key}
Add JSON metadata under the given key

Metrics

post
https:///
/api/v3/metrics
Query the collected metrics

Process

Oops, something is missing.
We could not find the original source to display this content.
post
https:///
/api/v3/process
Add a new process
get
https:///
/api/v3/process/{id}
List a process by its ID
put
https:///
/api/v3/process/{id}
Replace an existing process
delete
https:///
/api/v3/process/{id}
Delete a process by its ID
put
https:///
/api/v3/process/{id}/command
Issue a command to a process
get
https:///
/api/v3/process/{id}/config
Get the configuration of a process
get
https:///
/api/v3/process/{id}/metadata/{key}
Retrieve JSON metadata stored with a process under a key
put
https:///
/api/v3/process/{id}/metadata/{key}
Add JSON metadata with a process under the given key
get
https:///
/api/v3/process/{id}/playout/{inputid}/errorframe/encode
Encode the errorframe
post
https:///
/api/v3/process/{id}/playout/{inputid}/errorframe/{name}
Upload an error frame
get
https:///
/api/v3/process/{id}/playout/{inputid}/keyframe/{name}
Get the last keyframe
get
https:///
/api/v3/process/{id}/playout/{inputid}/reopen
Close the current input stream
get
https:///
/api/v3/process/{id}/playout/{inputid}/status
Get the current playout status
put
https:///
/api/v3/process/{id}/playout/{inputid}/stream
Switch to a new stream
get
https:///
/api/v3/process/{id}/probe
Probe a process
get
https:///
/api/v3/process/{id}/report
Get the logs of a process
get
https:///
/api/v3/process/{id}/state
Get the state of a process

RTMP

Oops, something is missing.
We could not find the original source to display this content.

Session

Oops, something is missing.
We could not find the original source to display this content.
get
https:///
/api/v3/session/active
Get a minimal summary of all active sessions

Skills

Oops, something is missing.
We could not find the original source to display this content.
get
https:///
/api/v3/skills/reload
Refresh FFmpeg capabilities

Widget

Oops, something is missing.
We could not find the original source to display this content.

Metrics

Oops, something is missing.
We could not find the original source to display this content.

Ping

Oops, something is missing.
We could not find the original source to display this content.

Profiling

Oops, something is missing.
We could not find the original source to display this content.

Learn more

Export as PDF
Copy link
On this page
API
GraphQL
post
/api/graph/query
get
/api/graph
Login
post
/api/login
get
/api/login/refresh
Swagger
get
/api/swagger
Config
get
/api/v3/config
get
/api/v3/config/reload
put
/api/v3/config
get
/api/v3/config/reload
Disk filesystem
get
/api/v3/fs/disk/
get
/api/v3/fs/disk/{path}
put
/api/v3/fs/disk/{path}
delete
/api/v3/fs/disk/{path}
In-Memory filesystem
get
/api/v3/fs/mem/
get
/api/v3/fs/mem/{path}
patch
/api/v3/fs/mem/{path}
put
/api/v3/fs/mem/{path}
delete
/api/v3/fs/mem/{path}
Logging
get
/api/v3/log
Metadata
get
/api/v3/metadata/{key}
put
/api/v3/metadata/{key}
Metrics
post
/api/v3/metrics
Process
get
/api/v3/process
post
/api/v3/process
get
/api/v3/process/{id}
put
/api/v3/process/{id}
delete
/api/v3/process/{id}
put
/api/v3/process/{id}/command
get
/api/v3/process/{id}/config
get
/api/v3/process/{id}/metadata/{key}
put
/api/v3/process/{id}/metadata/{key}
get
/api/v3/process/{id}/playout/{inputid}/errorframe/encode
post
/api/v3/process/{id}/playout/{inputid}/errorframe/{name}
get
/api/v3/process/{id}/playout/{inputid}/keyframe/{name}
get
/api/v3/process/{id}/playout/{inputid}/reopen
get
/api/v3/process/{id}/playout/{inputid}/status
put
/api/v3/process/{id}/playout/{inputid}/stream
get
/api/v3/process/{id}/probe
get
/api/v3/process/{id}/report
get
/api/v3/process/{id}/state
RTMP
get
/api/v3/rtmp
Session
get
/api/v3/session
get
/api/v3/session/active
Skills
get
/api/v3/skills
get
/api/v3/skills/reload
Widget
get
/api/v3/widget/process/{id}
Metrics
get
/metrics
Ping
get
/ping
Profiling
get
/profiling
Learn more