Skip to content

Engines

Get all Engines

GET /api/engines

Returns all the Engines that are currently available in your Erizos Studio environment.

Response

The response is an array of Engines

Get Engine by ID

GET /api/engines/[ID]

Returns the Engine that corresponds to the Engine ID.

Request

Parameter Type Description
ID ID Uuid or the name of the Engine

Response

Engine Object

Add Engine

Adds a new engine to the outputs lists of the profile editor

POST /api/engines

Request Body 

1
2
3
4
5
6
7
{
    "type": "OUTPUT",
    "name": "My Output",
    "system": "UNREAL",
    "port": 5000,
    "address": "127.0.0.1"
}

Parameter Value Description
_id Uuid The id of the engine
type OutputType The type of engine, can either be "OUTPUT" (default) or "SNAPSHOT" for an engine used to create preview snaphsots
name String The name of the engine
system System The system of the render engine
address String The IP address or hostname to connect to the render engine
port Integer The port number used to connect to the render engine
data Object Additional metadata used to connect to the engine
createdAt Date Date and time the engine was created
updatedAt Date Date and time the engine was last updated
connected Boolean If Erizos Studio can currently connect to the render engine

Update an Engine

PUT /api/engines/[ID]

Updates the engine details.

Request

Parameter Type Description
ID ID Uuid or the name of the Engine

Request Body

1
2
3
4
5
6
7
{
"type": [ENGINE TYPE (ENUM)],
"name": "Engine Name",
"system": [SYSTEM NAME (STRING)],
"port": 6100,
"address": "127.0.0.1"
}
Parameter Value Description
type OutputType The type of eninge, can either be "OUTPUT" (default) or "SNAPSHOT" for an engine used to create preview snaphsots
name String The name of the engine
system System The system of the render engine
address String The IP address or hostname to connect to the render engine
port Integer The port number used to connect to the render engine

Response

The updated Engine object.

Delete Engine by ID

DELETE /api/engines/[ID]

Deletes the Engine that corresponds to the Engine ID.

Request

Parameter Type Description
ID ID Uuid or the name of the Engine