Application
/v1/vhosts/{vhost_name}/apps
POST
http://<OME_HOST>:<API_PORT>/v1/vhosts/{vhost_name}/apps
Creates Application
s in the VirtualHost
Request Example:
POST http://1.2.3.4:8081/v1/vhosts/default/apps
[
{
"name": "app",
"type": "live",
"outputProfiles": [
{
"name": "bypass_profile",
"outputStreamName": "${OriginStreamName}",
"encodes": {
"videos": [
{
"bypass": true
}
],
"audios": [
{
"bypass": true
}
]
}
}
]
}
]
Path Parameters
Name | Type | Description |
---|---|---|
vhost_name | string | A name of |
Headers
Name | Type | Description |
---|---|---|
authorization | string | A string for authentication in |
Request Body
Name | Type | Description |
---|---|---|
(json body) | array | A list of |
/v1/vhosts/{vhost_name}/apps
GET
http://<OME_HOST>:<API_PORT>/v1/vhosts/{vhost_name}/apps
Lists all application names in the VirtualHost
Request Example:
GET http://1.2.3.4:8081/v1/vhosts/default/apps
Path Parameters
Name | Type | Description |
---|---|---|
vhost_name | string | A name of VirtualHost |
Headers
Name | Type | Description |
---|---|---|
authorization | string | A string for authentication in |
/v1/vhosts/{vhost_name}/apps/{app_name}
GET
http://<OME_HOST>:<API_PORT>/v1/vhosts/{vhost_name}/apps/{app_name}
Gets the configuration of the Application
Request Example:
GET http://1.2.3.4:8081/v1/vhosts/default/apps/app
Path Parameters
Name | Type | Description |
---|---|---|
vhost_name | string | A name of |
app_name | string | A name of |
Headers
Name | Type | Description |
---|---|---|
authorization | string | A string for authentication in |
/v1/vhosts/{vhost_name}/apps/{app_name}
PUT
http://<OME_HOST>:<API_PORT>/v1/vhosts/{vhost_name}/apps/{app_name}
Changes the configuration of the Application
Request Example:
PUT http://1.2.3.4:8081/v1/vhosts/default/apps/app
{
"type": "live"
}
Path Parameters
Name | Type | Description |
---|---|---|
vhost_name | string | A name of |
app_name | string | A name of |
Headers
Name | Type | Description |
---|---|---|
authorization | string | A string for authentication in |
Request Body
Name | Type | Description |
---|---|---|
(json body) | object |
|
/v1/vhosts/{vhost_name}/apps/{app_name}
DELETE
http://<OME_HOST>:<API_PORT>/v1/vhosts/{vhost_name}/apps/{app_name}
Deletes the Application
Request Example:
DELETE http://1.2.3.4:8081/v1/vhosts/default/apps/app
Path Parameters
Name | Type | Description |
---|---|---|
vhost_name | string | A name of |
app_name | string | A name of |
Headers
Name | Type | Description |
---|---|---|
authorization | string | A string for authentication in |
Last updated