Versions Compared

Version Old Version 2 New Version Current
Changes made by

Ramya Raman (Unlicensed)

Ramya Raman (Unlicensed)

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Requires Authentication?

Yes

Response Formats

json

HTTP Methods

GET

Returns a list of receiver configuration data.

Resource URL

http

Version 6.0.4 onwards, MCM9000 supports capitalization of UUID and escape single quote on API 4.1.

GET receivers

Resource Information

API 4.1 is a replica of API 4.0 that allows,

  • Capitalization of UUID. For example, uuid : A498AEB9-5F00-4CA9-B68F-7DA97E7E6DA9

  • Allows single quotes. For example, don't care and dont care will be considered same.

Version 6.0.5 onwards MCM9000 supports, JXS TR-07 and TR-08 code type on API 4.1.

GET receivers

Resource Information

Requires Authentication?

Yes

Response Formats

json

HTTP Methods

GET

Returns a list of receiver configuration data.

Resource URL

http://{host}/api/4.1/receivers/.format

Example Request

GET 

  1. http://192.168.10.132/api/4.1/receivers/.json

Expand
titleRESPONSE
Code Block
languagejson
[
    {
        "Receiver": {
            "receiver_uuid": "007FA955-7AEB-41EE-AFE9-424B6BD5574D",
            "receiver_label": "6945_1-2318",
            "channel_uuid": "A498AEB9-5F00-4CA9-B68F-7DA97E7E6DA9",
            "channel_label": "6945_1",
            "enabled": true,
            "sdp_file": null,
            "stream_type": "MPEG-TS/Video",
            "program_number": 6945,
            "network": [
                {
                    "multicast_ip": "238.20.20.20",
                    "interface_ip": "192.168.10.132",
                    "source_ip": "0.0.0.0",
                    "multicast_port": 2000
                },
                {
                    "multicast_ip": "0.0.0.0",
                    "interface_ip": null,
                    "source_ip": "0.0.0.0",
                    "multicast_port": 0
                }
            ]
        }
    },
    {
        "Receiver": {
            "receiver_uuid": "1225DEC3-0B91-4B9F-A42C-047CD48C7A7A",
            "receiver_label": "mdash_1-7001",
            "channel_uuid": "89E451E5-42D7-4978-9514-C5A562ACB6E3",
            "channel_label": "mdash_1",
            "enabled": true,
            "sdp_file": null,
            "stream_type": "MPEG-DASH/Video",
            "url": "https://tv2-play-ew-live-aws-arn-dash.secure.footprint.net/__cl/cg:live/__c/tv2_fyn/__op/nd/__f/dash.mpd",
            "index": "video_1_720p5400",
            "attributes": {
                "bandwidth": 5400000,
                "codecs": "avc1.640020",
                "audio": null,
                "resolution": "1280x720"
            },
            "network": [
                {
                    "interface_ip": "192.168.10.132"
                }
            ]
        }
    },
    {
        "Receiver": {
            "receiver_uuid": "A9ED621C-B9D2-4627-B29E-6B59D8E8F09C",
            "receiver_label": "News-HD-501",
            "channel_uuid": "39CC542B-A530-4237-8627-832AD883E391",
            "channel_label": "News-HD",
            "enabled": true,
            "sdp_file": null,
            "stream_type": "MPEG-TS/Video",
            "program_number": 5,
            "network": [
                {
                    "multicast_ip": "239.10.10.20",
                    "interface_ip": "192.168.10.132",
                    "source_ip": "0.0.0.0",
                    "multicast_port": 2000
                },
                {
                    "multicast_ip": "225.0.1.1",
                    "interface_ip": null,
                    "source_ip": "0.0.0.0",
                    "multicast_port": 2000
                }
            ]
        }
    },
    {
        "Receiver": {
            "receiver_uuid": "BD4AF8BE-0669-4D0A-A59B-D9363BDDFD4F",
            "receiver_label": "kan_3-7001",
            "channel_uuid": "A9501290-24B6-471B-A593-7FC52732A859",
            "channel_label": "kan_3",
            "enabled": true,
            "sdp_file": null,
            "stream_type": "HLS/Video",
            "url": "https://kanlivep2event-i.akamaihd.net/hls/live/765937/765937/master.m3u8",
            "variant_url": "https://kanlivep2event-i.akamaihd.net/hls/live/765937/765937/source1_350/chunklist.m3u8",
            "attributes": {
                "bandwidth": 600000,
                "codecs": "avc1.77.21,mp4a.40.2",
                "audio": null,
                "resolution": "426x240"
            },
            "network": [
                {
                    "interface_ip": "192.168.10.132"
                }
            ]
        }
    },
    {
        "Receiver": {
            "receiver_uuid": "C89EAC11-8CA3-4C27-BD17-DBF225595CA8",
            "receiver_label": "BBC 1 CI-2315",
            "channel_uuid": "4AD1E355-1895-444C-A1DA-DA808D406853",
            "channel_label": "BBC 1 CI",
            "enabled": true,
            "sdp_file": null,
            "stream_type": "MPEG-TS/Video",
            "program_number": 6904,
            "network": [
                {
                    "multicast_ip": "239.10.10.20",
                    "interface_ip": "192.168.10.132",
                    "source_ip": "0.0.0.0",
                    "multicast_port": 2000
                },
                {
                    "multicast_ip": "225.0.1.1",
                    "interface_ip": null,
                    "source_ip": "0.0.0.0",
                    "multicast_port": 2000
                }
            ]
        }
    }
]

 

  

GET receivers/{id}

Resource Information

Requires Authentication?

Yes

Response Formats

json

HTTP Methods

GET

Returns a single specific receiver configuration data.

Resource URL

http://{host}/api/4.1/receivers/{id}/.format

Parameters

Parameter

Data Type

Descriptionuu

uuid
(required)

string

The UUID of the desired receiver.

Example Request

GET 

  1. http://192.168.10.132/api/4.1/receivers/007FA955-7AEB-41EE-AFE9-424B6BD5574D/.json

Expand
titleRESPONSE
Code Block
languagejson
{
    "Receiver": {
        "receiver_uuid": "007FA955-7AEB-41EE-AFE9-424B6BD5574D",
        "receiver_label": "6945_1-2318",
        "channel_uuid": "A498AEB9-5F00-4CA9-B68F-7DA97E7E6DA9",
        "channel_label": "6945_1",
        "enabled": true,
        "sdp_file": null,
        "stream_type": "MPEG-TS/Video",
        "program_number": 6945,
        "network": [
            {
                "multicast_ip": "238.20.20.20",
                "interface_ip": "192.168.10.132",
                "source_ip": "0.0.0.0",
                "multicast_port": 2000
            },
            {
                "multicast_ip": "0.0.0.0",
                "interface_ip": null,
                "source_ip": "0.0.0.0",
                "multicast_port": 0
            }
        ]
    }
}

 

 

PUT receivers/{id}

Resource Information

Requires Authentication?

Yes

Response Formats

json

HTTP Methods

PUT

Updates the network configuration in the receivers.

Resource URL

http://{host}/api/4.1/receivers/{uuid}/.format

Parameters

Parameter

Data Type

Description

uuid
(required)

string

The UUID of the desired receiver to be updated.

Example Request

PUT 

  1. http://192.168.10.132/api/4.1/receivers/A9ED621C-B9D2-4627-B29E-6B59D8E8F09C/.json

Body:
Expand
titleBODY
Code Block
languagejson
{
        "Receiver": {
            "receiver_
uuid
label": "
A9ED621C
News-
B9D2-4627-B29E-6B59D8E8F09C
HD-501",
            "
receiver
channel_label": "News-HD
-501
",
            "
channel_uuid
enabled":
"39CC542B-A530-4237-8627-832AD883E391"
true,
            "
channel
sdp_
label
file":
"News-HD", "enabled": true, "sdp_file": null,
null,
            
"stream_type": "MPEG-TS/Video",
            "program_number": 5,
            "network": [
                {
                    "multicast_ip": "239.10.10.21",
                    "interface_ip": "192.168.10.132",
                    "source_ip": "0.0.0.0",
                    "multicast_port": 1000
                },
                {
                    "multicast_ip": "225.0.1.1",
                    "interface_ip": null,
                    "source_ip": "0.0.0.0",
                    "multicast_port": 2000
                }
            ]
        }
    }
Response:
 Expand
titleRESPONSE
 Code Block
languagejson
{
    "Receiver": {
        "receiver_uuid": "A9ED621C-B9D2-4627-B29E-6B59D8E8F09C",
        "receiver_label": "News-HD-501",
        "channel_uuid": "39CC542B-A530-4237-8627-832AD883E391",
        "channel_label": "News-HD",
        "enabled": true,
        "sdp_file": null,
        "stream_type": "MPEG-TS/Video",
        "program_number": 5,
        "network": [
            {
                "multicast_ip": "239.10.10.21",
                "interface_ip": "192.168.10.132",
                "source_ip": "0.0.0.0",
                "multicast_port": 1000
            },
            {
                "multicast_ip": "225.0.1.1",
                "interface_ip": null,
                "source_ip": "0.0.0.0",
                "multicast_port": 2000
            }
        ]
    }
}
 
 
GET senders
Resource Information
Requires Authentication?
Yes
Response Formats
json
HTTP Methods
GET
Returns a list of senders configuration data.
Resource URL
http://{host}/api/4.1/senders/.format
Example Request
GET 
  1. http://192.168.10.132/api/4.1/senders/.json
 Expand
titleRESPONSE
 Code Block
languagejson
[
    {
        "Sender": {
            "sender_uuid": "5B21DD2C-0EAB-4DDE-8759-8D7617A01955",
            "sender_label": "Enc1_ts",
            "output_uuid": "880D1D99-0066-422E-BA42-2541E515D662",
            "output_label": "Enc1",
            "stream_type": "MPEG-TS",
            "enabled": true,
            "sdp_file": "v=0\r\no=- 1669543738 1669543738 IN IP4 192.168.10.132\r\ns=Video flow generated by MCM-9000\r\nt=0 0\r\nm=video 2000 UDP 33\r\nc=IN IP4 225.0.3.3/32\r\na=source-filter:incl IN IP4 225.0.3.3 192.168.10.132\r\na=program:1",
            "network": [
                {
                    "ttl": "16",
                    "interface_ip": "192.168.10.132",
                    "destination_ip": "225.0.3.3",
                    "destination_port": "2000"
                },
                {
                    "ttl": "16",
                    "interface_ip": null,
                    "destination_ip": "226.0.4.4",
                    "destination_port": "2000"
                }
            ]
        }
    },
    {
        "Sender": {
            "sender_uuid": "2F309F30-B3AE-46CC-B04C-745BC3000F0F",
            "sender_label": "Enc1_uncom_video",
            "output_uuid": "880D1D99-0066-422E-BA42-2541E515D662",
            "output_label": "Enc1",
            "stream_type": "2110-20",
            "enabled": false,
            "sdp_file": "",
            "network": [
                {
                    "ttl": "16",
                    "interface_ip": "192.168.10.132",
                    "destination_ip": "227.0.5.5",
                    "destination_port": "2000"
                },
                {
                    "ttl": "16",
                    "interface_ip": null,
                    "destination_ip": "228.0.6.6",
                    "destination_port": "2000"
                }
            ]
        }
    },
    {
        "Sender": {
            "sender_uuid": "69B830B0-5990-4D27-A482-9650EBC54447",
            "sender_label": "Enc1_uncom_audio",
            "output_uuid": "880D1D99-0066-422E-BA42-2541E515D662",
            "output_label": "Enc1",
            "stream_type": "2110-30",
            "enabled": false,
            "sdp_file": "",
            "network": [
                {
                    "ttl": "16",
                    "interface_ip": "192.168.10.132",
                    "destination_ip": "229.0.7.7",
                    "destination_port": "2001"
                },
                {
                    "ttl": "16",
                    "interface_ip": null,
                    "destination_ip": "230.0.8.8",
                    "destination_port": "2001"
                }
            ]
        }
    }
]
 
   
GET senders/{id}
Resource Information
Requires Authentication?
Yes
Response Formats
json
HTTP Methods
GET
Returns a single specific senders configuration data.
Resource URL
http://{host}/api/4.1/senders/{id}/.format
Parameters
Parameter
Data Type
Descriptionuu
uuid
(required)
string
The UUID of the desired senders.
Example Request
GET 
  1. http://192.168.10.132/api/4.1/senders/5B21DD2C-0EAB-4DDE-8759-8D7617A01955/.json
 Expand
titleRESPONSE
 Code Block
languagejson
{
    "Sender": {
        "sender_uuid": "5B21DD2C-0EAB-4DDE-8759-8D7617A01955",
        "sender_label": "Enc1_ts",
        "output_uuid": "880D1D99-0066-422E-BA42-2541E515D662",
        "output_label": "Enc1",
        "stream_type": "MPEG-TS",
        "enabled": true,
        "sdp_file": "v=0\r\no=- 1669543738 1669543738 IN IP4 192.168.10.132\r\ns=Video flow generated by MCM-9000\r\nt=0 0\r\nm=video 2000 UDP 33\r\nc=IN IP4 225.0.3.3/32\r\na=source-filter:incl IN IP4 225.0.3.3 192.168.10.132\r\na=program:1",
        "network": [
            {
                "ttl": "16",
                "interface_ip": "192.168.10.132",
                "destination_ip": "225.0.3.3",
                "destination_port": "2000"
            },
            {
                "ttl": "16",
                "interface_ip": null,
                "destination_ip": "226.0.4.4",
                "destination_port": "2000"
            }
        ]
    }
}
 
 
PUT senders/{id}
Resource Information
Requires Authentication?
Yes
Response Formats
json
HTTP Methods
PUT
Updates the network configuration in the senders.
Resource URL
http://{host}/api/4.1/senders/{uuid}/.format
Parameters
Parameter
Data Type
Description
uuid
(required)
string
The UUID of the desired sender to be updated.
Example Request
PUT 
  1. http://192.168.10.132/api/4.1/senders/5B21DD2C-0EAB-4DDE-8759-8D7617A01955/.json
Body:
 Expand
titleBODY
 Code Block
languagejson
{
    "Sender": {
        "sender_uuid": "5B21DD2C-0EAB-4DDE-8759-8D7617A01955",
        "sender_label": "Enc1_ts",
        "output_uuid": "880D1D99-0066-422E-BA42-2541E515D662",
        "output_label": "Enc1",
        "stream_type": "MPEG-TS",
        "enabled": true,
        "sdp_file": "v=0\r\no=- 1669543738 1669543738 IN IP4 192.168.10.132\r\ns=Video flow generated by MCM-9000\r\nt=0 0\r\nm=video 2000 UDP 33\r\nc=IN IP4 225.0.3.3/32\r\na=source-filter:incl IN IP4 225.0.3.3 192.168.10.132\r\na=program:1",
        "network": [
            {
                "ttl": "16",
                "interface_ip": "192.168.10.132",
                "destination_ip": "225.0.3.2",
                "destination_port": "1000"
            },
            {
                "ttl": "16",
                "interface_ip": null,
                "destination_ip": "226.0.4.4",
                "destination_port": "2000"
            }
        ]
    }
}
Response:
 Expand
titleRESPONSE
 Code Block
languagejson
{
    "Sender": {
        "sender_uuid": "5B21DD2C-0EAB-4DDE-8759-8D7617A01955",
        "sender_label": "Enc1_ts",
        "output_uuid": "880D1D99-0066-422E-BA42-2541E515D662",
        "output_label": "Enc1",
        "stream_type": "MPEG-TS",
        "enabled": true,
        "sdp_file": "v=0\r\no=- 1669543738 1669543738 IN IP4 192.168.10.132\r\ns=Video flow generated by MCM-9000\r\nt=0 0\r\na=group:DUP primary secondary\r\nm=video 1000 UDP 33\r\nc=IN IP4 225.0.3.2/32\r\na=source-filter:incl IN IP4 225.0.3.2 192.168.10.132\r\na=mid:primary\r\na=program:1\r\nm=video 2000 UDP 33\r\nc=IN IP4 226.0.4.4/32\r\na=source-filter:incl IN IP4 226.0.4.4 \r\na=mid:secondary\r\na=program:1",
        "network": [
            {
                "ttl": "16",
                "interface_ip": "192.168.10.132",
                "destination_ip": "225.0.3.2",
                "destination_port": "1000"
            },
            {
                "ttl": "16",
                "interface_ip": null,
                "destination_ip": "226.0.4.4",
                "destination_port": "2000"
            }
        ]
    }
}
 
 
GET Layouts
Resource Information
Requires Authentication?
Yes
Response Formats
json
HTTP Methods
GET
Returns a list of layouts configuration data.
Resource URL
http://{host}/api/4.1/layouts/.format
Example Request
GET 
  1. http://192.168.10.132/api/4.1/layouts/.json
 Expand
titleRESPONSE
GET layouts/{id}
Resource Information
Requires Authentication?
Yes
Response Formats
json
HTTP Methods
GET
Returns a single specific layouts configuration data.
Resource URL
http://{host}/api/4.1/layouts/{id}/.format
Parameters
Parameter
Data Type
Descriptionuu
uuid
(required)
string
The UUID of the desired layouts.
Example Request
GET 
  1. http://192.168.10.132/api/4.1/layouts/F45D9708-B192-4A30-964A-38113ED9B633/.json
 Code Block
languagejson
{
    "Layout": {
 Code Block
languagejson
 
   
[
    {
        "Layout": {
            
 
"uuid": "
F45D9708
65141E16-
B192
70A2-
4A30
4DC7-
964A
B037-
38113ED9B633
81FAC3B5EB79",
            "label": "
my
layout_
channel_Layout
test",
            "modified": "
1669543739062
1673274371914",
            "created": "
1669543737616
1673274354882",
            "text_mode": "Scroll",
            "background": null,
            "layout_type_uuid": "
F63D13F3
18DEB7D5-
4861
2354-
4B5B
405F-
AA9A
A179-
B4CE075DEF49
B483DC87125F",
            "layout_type_label": "
my_Layout
20 Channels",
            "Tiles": [
                {
                    "index": 1,
                    "channel_uuid": null,
                    "channel_label": null,
                    "content_type": "Channel",
                    "umd_1": "",
                    "umd_2": "",
                    "tally_settings": null,
                    "activation_mode": "Persistent"
                },
                {
                    "index": 2,
                    "channel_uuid": null,
                    "channel_label": null,
                    "content_type": "Channel",
                    "umd_1": "
#RESOLUTION#
",
                    "umd_2": "",
                    "tally_settings": null,
                    "activation_mode": "Persistent"
                },
                {
                    "index": 3,
                    "channel_uuid": null,
                    "channel_label": null,
                    "content_type": "Channel",
                    "umd_1": "",
                    "umd_2": "",
                    "tally_settings": null,
                    "activation_mode": "Persistent"
                },
          
]
     
}
 
}
 
 
PUT layouts/{id}
Resource Information
Requires Authentication?
Yes
Response Formats
json
HTTP Methods
PUT
Updates the network configuration in the layouts.
Resource URL
http://{host}/api/4.1/layouts/{uuid}/.format
Parameters
Parameter
Data Type
Description
uuid
(required)
string
The UUID of the desired layouts to be updated.
Example Request
PUT 
  1. http://192.168.10.132/api/4.1/senders/5B21DD2C-0EAB-4DDE-8759-8D7617A01955/.json
Body:
 Code Block
languagejson
{
{
          
"Layout":
 
{
         "
uuid
index": 
"f45d9708-b192-4a30-964a-38113ed9b633"
4,
        
"label": "my_channel_Layout",
            
 
"
modified
channel_uuid": 
"1669543739062"
null,
         
"created": "1669543737616",
           "
text
channel_
mode
label": 
"Scroll"
null,
        
"background": null,
            "
layout
content_type
_uuid
": "
F63D13F3-4861-4B5B-AA9A-B4CE075DEF49
Channel",
        
"layout_type_label": "my_Layout",
            "
Tiles
umd_1": 
[
"",
            
{
        "umd_2": "",
    
   "index":
 
1,
               
  
"
channel
tally_
uuid
settings": null,
                    "
channel
activation_
label
mode": "Persistent"
 
null,
               },
 
"content_type":
 
"Channel",
              {
  
"umd_1":
 
"",
                 "
umd_2
index": 
""
5,
                    "
tally
channel_
settings
uuid": null,
                
"activation_mode": "Persistent"
            },
            {
          
    
  "index
"
: 2,
                "
channel_
uuid
label": null,

          

    
 "channel_label":
 
null,
               
  
"content_type": "Channel",
                    "umd_1": "
#RESOLUTION#
",
                    "umd_2": "",
                    "tally_settings": null,
                    "activation_mode": "Persistent"
                },
                {
                    "index": 
3
6,
                    "channel_uuid": null,
                    "channel_label": null,
                    "content_type": "Channel",
                    "umd_1": "",
                    "umd_2": "",
                    "tally_settings": null,
                    "activation_mode": "Persistent"
            
}
    },
    
]
     
}
 
}
Response:
 Code Block
languagejson
 
 
GET channels/config
Resource Information
Requires Authentication?
Yes
Response Formats
json
HTTP Methods
GET
Returns a list of channels configuration data.
Resource URL
http://{host}/api/4.1/channels/config/.format
Example Request
GET 
  1. http://192.168.10.132/api/4.1/channels/config/.json
 Code Block
languagejson
 
   
GET channels/config/{id}
Resource Information
Requires Authentication?
Yes
Response Formats
json
HTTP Methods
GET
Returns a single specific channels configuration data.
Resource URL
http://{host}/api/4.1/channels/config/{id}/.format
Parameters
Parameter
Data Type
Descriptionuu
uuid
(required)
string
The UUID of the desired channel configuration.
Example Request
GET 
  1. http://192.168.10.132/api/4.1/channels/config/F45D9708-B192-4A30-964A-38113ED9B633/.json
 Code Block
languagejson
 
 
GET outputs/config
Resource Information
Requires Authentication?
Yes
Response Formats
json
HTTP Methods
GET
Returns a list of outputs configuration data.
Resource URL
http://{host}/api/4.1/outputs/config/.format
Example Request
GET 
  1. http://192.168.10.132/api/4.1/outputs/config/.json
 Code Block
languagejson
 
   
GET outputs/config/{id}
Resource Information
Requires Authentication?
Yes
Response Formats
json
HTTP Methods
GET
Returns a single specific outputs configuration data.
Resource URL
http://{host}/api/4.1/outputs/config/{id}/.format
Parameters
Parameter
Data Type
Descriptionuu
uuid
(required)
string
The UUID of the desired output configuration.
Example Request
GET 
  1. http://192.168.10.132/api/4.1/outputs/config/880D1D99-0066-422E-BA42-2541E515D662/.json
json
 Code Block
language{
     
"Layout":
 {
          
"uuid":
 
"F45D9708-B192-4A30-964A-38113ED9B633",
         "
label
index": 
"my_channel_Layout",
7,
          
"modified":
 
"1670834516415",
         "
created
channel_uuid": 
"1669543737616"
null,
        
"text_mode": "Scroll",
            "
background
channel_label": null,
          
"layout_type_uuid":
 
"F63D13F3-4861-4B5B-AA9A-B4CE075DEF49",
         "
layout
content_type
_label
": "
my_Layout
Channel",
          
"Tiles":
  
[
        "umd_1": "",
   
{
                 "
index
umd_2": 
1
"",
                    "
channel
tally_
uuid
settings": null,
                    "
channel
activation_
label
mode": "Persistent"

null,
                
 "content_type": "Channel",
},
                {
 
"umd_1": "",
                   "
umd_2
index": 
""
8,
                    "
tally
channel_
settings
uuid": null,
                    "
activation
channel_
mode
label": 
"Persistent"
null,
            
},
        "content_type": "Channel",
   
{
                 "
index
umd_1": 
2
"",
                    "
channel
umd_
uuid
2": 
null,
"",
                    "
channel
tally_
label
settings": null,
                    "
content
activation_
type
mode": "
Channel
Persistent"
,

                
 "umd_1": "#RESOLUTION#",
},
                {
  
"umd_2":
 
"",
                 "
tally_settings
index": 
null
9,
                    "
activation
channel_
mode
uuid": 
"Persistent"
null,
            
},
        
 
"channel_label": null,
   
{
                 "
index
content_type": 
3
"Channel",
                    "
channel
umd_
uuid
1": 
null
"",
                    "
channel
umd_
label
2": 
null
"",
                    "
content
tally_
type
settings": 
"Channel",
null,
                    "
umd
activation_
1
mode": "Persistent"
                },
                {
                
"umd_2
    "index": 
""
10,
                    "
tally
channel_
settings
uuid": null,
                    "
activation
channel_
mode
label":
 "Persistent"
 null,
                    
}

"content_type": "Channel",
       
]
     
}
}
 
  
GET layout_types
Resource Information
Requires Authentication?
Yes
Response Formats
json
HTTP Methods
GET
Returns a single specific layout_types configuration data.
Resource URL
http://{host}/api/4.1/layout_types/.format
Example Request
GET 
  1. http://192.168.10.132/api/4.1/layout_types/.json
 View file
nameLayout_types.json
        "umd_1": "",
                    "umd_2": "",
                    "tally_settings": null,
                    "activation_mode": "Persistent"
                },
                {
                    "index": 11,
                    "channel_uuid": null,
                    "channel_label": null,
                    "content_type": "Channel",
                    "umd_1": "",
                    "umd_2": "",
                    "tally_settings": null,
                    "activation_mode": "Persistent"
                },
                {
                    "index": 12,
                    "channel_uuid": null,
                    "channel_label": null,
                    "content_type": "Channel",
                    "umd_1": "",
                    "umd_2": "",
                    "tally_settings": null,
                    "activation_mode": "Persistent"
                },
                {
                    "index": 13,
                    "channel_uuid": null,
                    "channel_label": null,
                    "content_type": "Channel",
                    "umd_1": "",
                    "umd_2": "",
                    "tally_settings": null,
                    "activation_mode": "Persistent"
                },
                {
                    "index": 14,
                    "channel_uuid": null,
                    "channel_label": null,
                    "content_type": "Channel",
                    "umd_1": "",
                    "umd_2": "",
                    "tally_settings": null,
                    "activation_mode": "Persistent"
                },
                {
                    "index": 15,
                    "channel_uuid": null,
                    "channel_label": null,
                    "content_type": "Channel",
                    "umd_1": "",
                    "umd_2": "",
                    "tally_settings": null,
                    "activation_mode": "Persistent"
                },
                {
                    "index": 16,
                    "channel_uuid": null,
                    "channel_label": null,
                    "content_type": "Channel",
                    "umd_1": "",
                    "umd_2": "",
                    "tally_settings": null,
                    "activation_mode": "Persistent"
                },
                {
                    "index": 17,
                    "channel_uuid": null,
                    "channel_label": null,
                    "content_type": "Channel",
                    "umd_1": "",
                    "umd_2": "",
                    "tally_settings": null,
                    "activation_mode": "Persistent"
                },
                {
                    "index": 18,
                    "channel_uuid": null,
                    "channel_label": null,
                    "content_type": "Channel",
                    "umd_1": "",
                    "umd_2": "",
                    "tally_settings": null,
                    "activation_mode": "Persistent"
                },
                {
                    "index": 19,
                    "channel_uuid": null,
                    "channel_label": null,
                    "content_type": "Channel",
                    "umd_1": "",
                    "umd_2": "",
                    "tally_settings": null,
                    "activation_mode": "Persistent"
                },
                {
                    "index": 20,
                    "channel_uuid": null,
                    "channel_label": null,
                    "content_type": "Channel",
                    "umd_1": "",
                    "umd_2": "",
                    "tally_settings": null,
                    "activation_mode": "Persistent"
                }
            ]
        }
    }
]
 
   
GET layouts/{id}
Resource Information
Requires Authentication?
Yes
Response Formats
json
HTTP Methods
GET
Returns a single specific layouts configuration data.
Resource URL
http://{host}/api/4.1/layouts/{id}/.format
Parameters
Parameter
Data Type
Descriptionuu
uuid
(required)
string
The UUID of the desired layouts.
Example Request
GET 
  1. http://192.168.10.132/api/4.1/layouts/F45D9708-B192-4A30-964A-38113ED9B633/.json
 Expand
titleRESPONSE
 Code Block
languagejson
{
    "Layout": {
        "uuid": "F45D9708-B192-4A30-964A-38113ED9B633",
        "label": "my_channel_Layout",
        "modified": "1669543739062",
        "created": "1669543737616",
        "text_mode": "Scroll",
        "background": null,
        "layout_type_uuid": "F63D13F3-4861-4B5B-AA9A-B4CE075DEF49",
        "layout_type_label": "my_Layout",
        "Tiles": [
            {
                "index": 1,
                "channel_uuid": null,
                "channel_label": null,
                "content_type": "Channel",
                "umd_1": "",
                "umd_2": "",
                "tally_settings": null,
                "activation_mode": "Persistent"
            },
            {
                "index": 2,
                "channel_uuid": null,
                "channel_label": null,
                "content_type": "Channel",
                "umd_1": "#RESOLUTION#",
                "umd_2": "",
                "tally_settings": null,
                "activation_mode": "Persistent"
            },
            {
                "index": 3,
                "channel_uuid": null,
                "channel_label": null,
                "content_type": "Channel",
                "umd_1": "",
                "umd_2": "",
                "tally_settings": null,
                "activation_mode": "Persistent"
            }
        ]
    }
}
 
 
PUT layouts/{id}
Resource Information
Requires Authentication?
Yes
Response Formats
json
HTTP Methods
PUT
Updates the network configuration in the layouts.
Resource URL
http://{host}/api/4.1/layouts/{uuid}/.format
Parameters
Parameter
Data Type
Description
uuid
(required)
string
The UUID of the desired layouts to be updated.
Example Request
PUT 
  1. http://192.168.10.132/api/4.1/senders/5B21DD2C-0EAB-4DDE-8759-8D7617A01955/.json
 Expand
titleBODY
 Code Block
languagejson
{
    "Layout": {
        "label": "my_channel_Layout",
        "text_mode": "Scroll",
        "background": null,
        "layout_type_label": "my_Layout",
        "Tiles": [
            {
                "index": 1,
                "channel_uuid": null,
                "channel_label": null,
                "content_type": "Channel",
                "umd_1": "",
                "umd_2": "",
                "tally_settings": null,
                "activation_mode": "Persistent"
            },
            {
                "index": 2,
                "channel_uuid": null,
                "channel_label": null,
                "content_type": "Channel",
                "umd_1": "#RESOLUTION#",
                "umd_2": "",
                "tally_settings": null,
                "activation_mode": "Persistent"
            },
            {
                "index": 3,
                "channel_uuid": null,
                "channel_label": null,
                "content_type": "Channel",
                "umd_1": "",
                "umd_2": "",
                "tally_settings": null,
                "activation_mode": "Persistent"
            }
        ]
    }
}
 Expand
titleRESPONSE
 Code Block
languagejson
{
    "Layout": {
        "uuid": "F45D9708-B192-4A30-964A-38113ED9B633",
        "label": "my_channel_Layout",
        "modified": "1670834516415",
        "created": "1669543737616",
        "text_mode": "Scroll",
        "background": null,
        "layout_type_uuid": "F63D13F3-4861-4B5B-AA9A-B4CE075DEF49",
        "layout_type_label": "my_Layout",
        "Tiles": [
            {
                "index": 1,
                "channel_uuid": null,
                "channel_label": null,
                "content_type": "Channel",
                "umd_1": "",
                "umd_2": "",
                "tally_settings": null,
                "activation_mode": "Persistent"
            },
            {
                "index": 2,
                "channel_uuid": null,
                "channel_label": null,
                "content_type": "Channel",
                "umd_1": "#RESOLUTION#",
                "umd_2": "",
                "tally_settings": null,
                "activation_mode": "Persistent"
            },
            {
                "index": 3,
                "channel_uuid": null,
                "channel_label": null,
                "content_type": "Channel",
                "umd_1": "",
                "umd_2": "",
                "tally_settings": null,
                "activation_mode": "Persistent"
            }
        ]
    }
}
 
  
GET layout_types
Resource Information
Requires Authentication?
Yes
Response Formats
json
HTTP Methods
GET
Returns a single specific layout_types configuration data.
Resource URL
http://{host}/api/4.1/layout_types/.format
Example Request
GET 
  1. http://192.168.10.132/api/4.1/layout_types/.json
 View file
nameLayout_types.json
 
 
GET channels/config
Resource Information
Requires Authentication?
Yes
Response Formats
json
HTTP Methods
GET
Returns a list of channels configuration data.
Resource URL
http://{host}/api/4.1/channels/config/.format
Example Request
GET 
  1. http://192.168.10.132/api/4.1/channels/config/.json
 Expand
titleRESPONSE
 Code Block
languagejson
[
    {
        "Channel": {
            "uuid": "965FFA9A-0C0C-43F1-A448-AD224AE45E30",
            "title": "test_channel1",
            "modified": "1673274481541",
            "created": "1673274481535",
            "access_type": "MPTS",
            "snooze_on_profile_change": 10,
            "service_type": "SD Video",
            "enabled": false,
            "device_id": null,
            "note": "",
            "tally_settings": "",
            "Profiles": [
                {
                    "uuid": "E7206FE6-1A24-40A6-BB9A-F68383EAA0B8",
                    "label": "Default",
                    "notification_set_uuid": "F3A31BC3-E53F-4B63-9605-CD0B6121E602",
                    "notification_set_label": "Default",
                    "threshold_set_uuid": "B026DD10-9B84-42DB-805A-16F1E97B10DA",
                    "threshold_set_label": "Default",
                    "is_default": true,
                    "title_color": "Default",
                    "border_color": "Default",
                    "pixelate_level": "None",
                    "Components": [],
                    "Receivers": [
                        {
                            "uuid": null,
                            "stream_type": "MPEG-TS/Video",
                            "program_number": 200,
                            "enabled": false,
                            "network": [
                                {
                                    "multicast_ip": "224.0.1.1",
                                    "interface_ip": null,
                                    "source_ip": null,
                                    "multicast_port": 1000
                                },
                                {
                                    "multicast_ip": null,
                                    "interface_ip": null,
                                    "source_ip": null,
                                    "multicast_port": null
                                }
                            ]
                        }
                    ]
                }
            ]
        }
    },
    {
        "Channel": {
            "uuid": "96B18BA8-8342-42A4-986A-555EAA80FCCC",
            "title": "uncompressed",
            "modified": "1673274492923",
            "created": "1673274492918",
            "access_type": "Uncompressed",
            "snooze_on_profile_change": 10,
            "service_type": "HD Video",
            "enabled": false,
            "device_id": null,
            "note": "",
            "tally_settings": "",
            "Profiles": [
                {
                    "uuid": "D135CA65-EAAD-4F77-BF71-D746BB2927FA",
                    "label": "Default",
                    "notification_set_uuid": "F3A31BC3-E53F-4B63-9605-CD0B6121E602",
                    "notification_set_label": "Default",
                    "threshold_set_uuid": "B026DD10-9B84-42DB-805A-16F1E97B10DA",
                    "threshold_set_label": "Default",
                    "is_default": true,
                    "title_color": "Default",
                    "border_color": "Default",
                    "pixelate_level": "None",
                    "Receivers": [],
                    "Components": []
                }
            ]
        }
    }
]
 
   
GET channels/config/{id}
Resource Information
Requires Authentication?
Yes
Response Formats
json
HTTP Methods
GET
Returns a single specific channels configuration data.
Resource URL
http://{host}/api/4.1/channels/config/{id}/.format
Parameters
Parameter
Data Type
Descriptionuu
uuid
(required)
string
The UUID of the desired channel configuration.
Example Request
GET 
  1. http://192.168.10.132/api/4.1/channels/config/F45D9708-B192-4A30-964A-38113ED9B633/.json
 Expand
titleRESPONSE
 Code Block
languagejson
{
    "Channel": {
        "uuid": "965FFA9A-0C0C-43F1-A448-AD224AE45E30",
        "title": "test_channel1",
        "modified": "1673274481541",
        "created": "1673274481535",
        "access_type": "MPTS",
        "snooze_on_profile_change": 10,
        "service_type": "SD Video",
        "enabled": false,
        "device_id": null,
        "note": "",
        "tally_settings": "",
        "Profiles": [
            {
                "uuid": "E7206FE6-1A24-40A6-BB9A-F68383EAA0B8",
                "label": "Default",
                "notification_set_uuid": "F3A31BC3-E53F-4B63-9605-CD0B6121E602",
                "notification_set_label": "Default",
                "threshold_set_uuid": "B026DD10-9B84-42DB-805A-16F1E97B10DA",
                "threshold_set_label": "Default",
                "is_default": true,
                "title_color": "Default",
                "border_color": "Default",
                "pixelate_level": "None",
                "Components": [],
                "Receivers": [
                    {
                        "uuid": null,
                        "stream_type": "MPEG-TS/Video",
                        "program_number": 200,
                        "enabled": false,
                        "network": [
                            {
                                "multicast_ip": "224.0.1.1",
                                "interface_ip": null,
                                "source_ip": null,
                                "multicast_port": 1000
                            },
                            {
                                "multicast_ip": null,
                                "interface_ip": null,
                                "source_ip": null,
                                "multicast_port": null
                            }
                        ]
                    }
                ]
            }
        ]
    }
}
 
GET outputs/config
Resource Information
Requires Authentication?
Yes
Response Formats
json
HTTP Methods
GET
Returns a list of outputs configuration data.
Resource URL
http://{host}/api/4.1/outputs/config/.format
Example Request
GET 
  1. http://192.168.10.132/api/4.1/outputs/config/.json
 Expand
titleRESPONSE
 Code Block
languagejson
[
    {
        "Output": {
            "uuid": "880D1D99-0066-422E-BA42-2541E515D662",
            "label": "Enc1",
            "modified": "1670833362762",
            "created": "1669543737686",
            "enabled": true,
            "device_id": 9232,
            "resolution": "1920x1080",
            "enable_alarms_display": true,
            "input_loss_mode": "Icon",
            "frame_rate": "25 fps",
            "layout_change_interval": null,
            "Senders": [
                {
                    "uuid": "5B21DD2C-0EAB-4DDE-8759-8D7617A01955",
                    "stream_type": "MPEG-TS",
                    "enabled": true,
                    "transport_stream_id": 1,
                    "transport_mode": "SPTS/UDP",
                    "vbv_limit": null,
                    "enable_interlaced": true,
                    "enable_deblocking": true,
                    "program_number": 1,
                    "ts_per_ip": 7,
                    "enable_null_padding": true,
                    "pmt_pid": 200,
                    "video_pid": 201,
                    "transcoded_audio_pid": 0,
                    "passthrough_audio_pid": 0,
                    "min_chunk_length": 2,
                    "number_of_chunks": 3,
                    "hls_index_interval": null,
                    "enable_downscale": false,
                    "enable_ratescale": false,
                    "codec_type": "H.264",
                    "video_bitrate": 14000000,
                    "jxs_bitrate": 0,
                    "gop_size_mode": "Static, IPB Frames",
                    "gop_size": "24",
                    "network": [
                        {
                            "ttl": "16",
                            "interface_ip": "192.168.10.132",
                            "destination_ip": "225.0.3.2",
                            "destination_port": 1000
                        },
                        {
                            "ttl": "16",
                            "interface_ip": false,
                            "destination_ip": "226.0.4.4",
                            "destination_port": 2000
                        }
                    ]
                },
                {
                    "uuid": "2F309F30-B3AE-46CC-B04C-745BC3000F0F",
                    "stream_type": "2110/Video",
                    "enabled": false,
                    "uhd_mode": "HD-SDI (Interlaced)",
                    "latency_mode": "5 Frames",
                    "payload_type": 0,
                    "avoid_c_bit": false,
                    "network": [
                        {
                            "ttl": "16",
                            "interface_ip": "192.168.10.132",
                            "destination_ip": "227.0.5.5",
                            "destination_port": 2000
                        },
                        {
                            "ttl": "16",
                            "interface_ip": false,
                            "destination_ip": "228.0.6.6",
                            "destination_port": 2000
                        }
                    ]
                },
                {
                    "uuid": "69B830B0-5990-4D27-A482-9650EBC54447",
                    "stream_type": "2110/Audio",
                    "enabled": false,
                    "payload_type": 0,
                    "network": [
                        {
                            "ttl": "16",
                            "interface_ip": "192.168.10.132",
                            "destination_ip": "229.0.7.7",
                            "destination_port": 2001
                        },
                        {
                            "ttl": "16",
                            "interface_ip": false,
                            "destination_ip": "230.0.8.8",
                            "destination_port": 2001
                        }
                    ]
                }
            ],
            "Layouts": [
                {
                    "uuid": "928F2E96-EF11-4F25-9574-543E6D7CCBBF",
                    "label": "test 789"
                }
            ]
        }
    }
]
 
   
GET outputs/config/{id}
Resource Information
Requires Authentication?
Yes
Response Formats
json
HTTP Methods
GET
Returns a single specific outputs configuration data.
Resource URL
http://{host}/api/4.1/outputs/config/{id}/.format
Parameters
Parameter
Data Type
Descriptionuu
uuid
(required)
string
The UUID of the desired output configuration.
Example Request
GET 
  1. http://192.168.10.132/api/4.1/outputs/config/880D1D99-0066-422E-BA42-2541E515D662/.json
 Expand
titleRESPONSE
 Code Block
languagejson
{
    "Output": {
        "uuid": "880D1D99-0066-422E-BA42-2541E515D662",
        "label": "Enc1",
        "modified": "1670833362762",
        "created": "1669543737686",
        "enabled": true,
        "device_id": 9232,
        "resolution": "1920x1080",
        "enable_alarms_display": true,
        "input_loss_mode": "Icon",
        "frame_rate": "25 fps",
        "layout_change_interval": null,
        "Senders": [
            {
                "uuid": "5B21DD2C-0EAB-4DDE-8759-8D7617A01955",
                "stream_type": "MPEG-TS",
                "enabled": true,
                "transport_stream_id": 1,
                "transport_mode": "SPTS/UDP",
                "vbv_limit": null,
                "enable_interlaced": true,
                "enable_deblocking": true,
                "program_number": 1,
                "ts_per_ip": 7,
                "enable_null_padding": true,
                "pmt_pid": 200,
                "video_pid": 201,
                "transcoded_audio_pid": 0,
                "passthrough_audio_pid": 0,
                "min_chunk_length": 2,
                "number_of_chunks": 3,
                "hls_index_interval": null,
                "enable_downscale": false,
                "enable_ratescale": false,
                "codec_type": "H.264",
                "video_bitrate": 14000000,
                "jxs_bitrate": 0,
                "gop_size_mode": "Static, IPB Frames",
                "gop_size": "24",
                "network": [
                    {
                        "ttl": "16",
                        "interface_ip": "192.168.10.132",
                        "destination_ip": "225.0.3.2",
                        "destination_port": 1000
                    },
                    {
                        "ttl": "16",
                        "interface_ip": false,
                        "destination_ip": "226.0.4.4",
                        "destination_port": 2000
                    }
                ]
            },
            {
                "uuid": "2F309F30-B3AE-46CC-B04C-745BC3000F0F",
                "stream_type": "2110/Video",
                "enabled": false,
                "uhd_mode": "HD-SDI (Interlaced)",
                "latency_mode": "5 Frames",
                "payload_type": 0,
                "avoid_c_bit": false,
                "network": [
                    {
                        "ttl": "16",
                        "interface_ip": "192.168.10.132",
                        "destination_ip": "227.0.5.5",
                        "destination_port": 2000
                    },
                    {
                        "ttl": "16",
                        "interface_ip": false,
                        "destination_ip": "228.0.6.6",
                        "destination_port": 2000
                    }
                ]
            },
            {
                "uuid": "69B830B0-5990-4D27-A482-9650EBC54447",
                "stream_type": "2110/Audio",
                "enabled": false,
                "payload_type": 0,
                "network": [
                    {
                        "ttl": "16",
                        "interface_ip": "192.168.10.132",
                        "destination_ip": "229.0.7.7",
                        "destination_port": 2001
                    },
                    {
                        "ttl": "16",
                        "interface_ip": false,
                        "destination_ip": "230.0.8.8",
                        "destination_port": 2001
                    }
                ]
            }
        ],
        "Layouts": [
            {
                "uuid": "928F2E96-EF11-4F25-9574-543E6D7CCBBF",
                "label": "test 789"
            }
        ]
    }
}