- Created by Ramya Raman, last modified on Jun 12, 2023
You are viewing an old version of this page. View the current version.
Compare with Current View Page History
« Previous Version 5 Current »
GET channels/scan/config
Resource Information
Requires Authentication? | |
Response Formats | json |
HTTP Methods | GET |
Returns a list of all scan channel in the system, with its main configuration data.
Resource URL
https://{{ip_address}}:{{port}}/api/{{version}}/channels/scan/config
Example Request
GET
{ "data": [ { "uuid": "5463a199-6c69-40e6-bda3-f2a989afc8e0", "id": "11", "note": "mpeg_dash_test", "created": "2021-12-01T14:17:57.072Z", "modified": "2022-02-02T10:48:48.325Z", "entries": [ { "label": "mpeg_dash_test", "source": "https://webdav00.ipcasting.jp/iij-ch11/live.mpd", "network": "2a62e295-f305-4d98-b6bb-237467f2221d", "access_type": "MPEG-DASH" } ] }, { "uuid": "13d02fd8-773a-426a-b664-87cd5c6bfb7e", "id": "2", "note": "KAN", "created": "2021-11-04T13:58:21.286Z", "modified": "2022-02-02T10:48:48.325Z", "entries": [ { "label": "KAN#RES|BAND#", "source": "https://kanlivep2event-i.akamaihd.net/hls/live/765937/765937/master.m3u8", "network": "2a62e295-f305-4d98-b6bb-237467f2221d", "access_type": "HLS" } ] }, { "uuid": "e74365f3-d042-4fa5-9df5-9f70a0380089", "id": "4", "note": "Fox", "created": "2021-11-10T10:18:59.698Z", "modified": "2022-02-02T10:48:48.325Z", "entries": [ { "label": "FOX#RES|BAND#", "source": "https://content.uplynk.com/channel/4a4d27543b24417e9243a84e03b24671.m3u8?expand=monitor", "network": "2a62e295-f305-4d98-b6bb-237467f2221d", "access_type": "HLS" } ] }, { "uuid": "253fb475-ca1a-4473-ac94-4c83788ba6b6", "id": "7", "note": "rtmp", "created": "2021-11-13T15:52:19.835Z", "modified": "2022-02-02T10:48:48.325Z", "entries": [ { "label": "rtmp", "source": "rtmp://bintu-play.nanocosmos.de:80/play/zoZ7x-DvCQK", "network": "2a62e295-f305-4d98-b6bb-237467f2221d", "access_type": "RTMP" } ] }, { "uuid": "1f83330b-6c78-48e1-b23b-f9047183580c", "id": "3", "note": "mpts", "created": "2021-11-04T15:53:43.137Z", "modified": "2022-02-02T10:48:48.325Z", "entries": [ { "port": 2000, "label": "#SDT|ADDR#", "source": "229.10.1.1", "network": "2a62e295-f305-4d98-b6bb-237467f2221d", "access_type": "MPEG-TS", "ssm_ip_address": null }, { "port": 2000, "label": "#SDT|ADDR#", "source": "229.10.1.12", "network": "2a62e295-f305-4d98-b6bb-237467f2221d", "access_type": "MPEG-TS", "ssm_ip_address": null } ] }, { "uuid": "c51efcaa-8908-4aeb-99ca-291c70548c30", "id": "8", "note": "ndi", "created": "2021-11-15T12:09:08.421Z", "modified": "2022-02-02T10:48:48.325Z", "entries": [ { "label": "NDI", "source": "ndi://192.168.1.213", "network": "2a62e295-f305-4d98-b6bb-237467f2221d", "access_type": "NDI" } ] }, { "uuid": "ece76a01-10c6-4abf-9556-965ebf50316e", "id": "9", "note": "ndi_test", "created": "2021-11-29T09:25:30.465Z", "modified": "2022-02-02T10:48:48.325Z", "entries": [ { "label": "ndi_test", "source": "ndi://192.168.1.213", "network": "2a62e295-f305-4d98-b6bb-237467f2221d", "access_type": "NDI" } ] }, { "uuid": "e7b71ef2-77e8-4f8b-b5ac-125a6cc14ecc", "id": "10", "note": "mpeg_TS", "created": "2021-12-01T10:10:06.880Z", "modified": "2022-02-02T10:48:48.325Z", "entries": [ { "port": 2000, "label": "#SDT|ADDR#", "source": "229.10.1.1", "network": "2a62e295-f305-4d98-b6bb-237467f2221d", "access_type": "MPEG-TS", "ssm_ip_address": null }, { "port": 2000, "label": "#SDT|ADDR#", "source": "229.10.1.2", "network": "2a62e295-f305-4d98-b6bb-237467f2221d", "access_type": "MPEG-TS", "ssm_ip_address": null } ] }, { "uuid": "844ff51c-16bc-444f-bfb0-8a5a6c496d41", "id": "12", "note": "Zixi", "created": "2022-01-07T04:49:10.026Z", "modified": "2022-02-02T10:48:48.325Z", "entries": [ { "label": "#SDT|ADDR#", "source": "zixi://demo.zixi.com/clocks", "network": "2a62e295-f305-4d98-b6bb-237467f2221d", "access_type": "ZIXI" } ] }, { "uuid": "4dfcd05d-8e5d-4128-96cc-aa1337586f04", "id": "14", "note": "MPEG_TS2\n", "created": "2022-01-16T13:54:13.028Z", "modified": "2022-02-02T10:48:48.325Z", "entries": [ { "port": 2000, "label": "#SDT|ADDR#", "source": "226.10.10.1", "network": "2a62e295-f305-4d98-b6bb-237467f2221d", "access_type": "MPEG-TS", "ssm_ip_address": null }, { "port": 2000, "label": "#SDT|ADDR#", "source": "226.10.10.2", "network": "2a62e295-f305-4d98-b6bb-237467f2221d", "access_type": "MPEG-TS", "ssm_ip_address": null } ] }, { "uuid": "9f94bc75-c386-447d-a17a-db33dafda4f0", "id": "15", "note": "Scan 2/2/2022, 3:07:19 PM", "created": "2022-02-02T13:07:50.587Z", "modified": "2022-02-02T13:07:50.587Z", "entries": [ { "port": 2000, "label": "BBC", "source": "225.0.5.7", "network": "2a62e295-f305-4d98-b6bb-237467f2221d", "access_type": "MPEG-TS", "ssm_ip_address": null } ] }, { "uuid": "14ab663a-245b-4991-9219-7673c124db78", "id": "16", "note": "Scan 2/7/2022, 11:19:18 PM", "created": "2022-02-07T17:49:35.809Z", "modified": "2022-02-07T17:49:35.809Z", "entries": [ { "port": 1000, "label": "#SDT|ADDR#", "source": "1.1.1.1", "network": "7c9ecb05-8da2-4f8e-b3ae-b8c523f46f7a", "access_type": "MPEG-TS", "ssm_ip_address": null } ] } ], "metadata": { "item_count": 12, "total_items": 12, "current_page": 1, "sort_by": [ { "field": "modified", "direction": "ASC" } ], "links": { "current": "http://192.168.10.53/api/5.0/channels/scan/config" } } }
GET channels/scan/config/{uuid}
Resource Information
Requires Authentication? | |
Response Formats | json |
HTTP Methods | GET |
Returns an extended single scan configuration view, specified by the required {uuid} parameter.
Resource URL
https://{{ip_address}}:{{port}}/api/{{version}}/channels/scan/config/{{uuid}}
Parameters
Parameter | Data Type | Description |
---|---|---|
uuid | string | The UUID of the desired scan config. |
Example Request
GET
{ "data": { "uuid": "5463a199-6c69-40e6-bda3-f2a989afc8e0", "id": "11", "note": "mpeg_dash_test", "created": "2021-12-01T14:17:57.072Z", "modified": "2022-02-02T10:48:48.325Z", "entries": [ { "label": "mpeg_dash_test", "source": "https://webdav00.ipcasting.jp/iij-ch11/live.mpd", "network": "2a62e295-f305-4d98-b6bb-237467f2221d", "access_type": "MPEG-DASH" } ] }, "metadata": {} }
DELETE channels/scan/config/{uuid}
Resource Information
Requires Authentication? | |
Response Formats | json |
HTTP Methods | DELETE |
Delete a specific scan configuration.
Resource URL
https://{{ip_address}}:{{port}}/api/{{version}}/channels/scan/config/{{uuid}}
Parameters
Parameter | Data Type | Description |
---|---|---|
uuid | string | The UUID of the scan config to be deleted. |
Example Request
DELETE
{ "data": { "success": true }, "metadata": {} }
PUT channels/scan/config/{uuid}
Resource Information
Requires Authentication? | |
Response Formats | json |
HTTP Methods | PUT |
Edit a scan configuration.
Resource URL
https://{{ip_address}}:{{port}}/api/{{version}}/channels/scan/config/{{uuid}}
Parameters
Parameter | Data Type | Description |
---|---|---|
uuid | byte | The UUID of the scan config to be edited. |
Example Request
PUT
Body
{ "note": "mpeg_dash_edited", "entries": [ { "label": "mpeg_dash_new_edited", "source": "https://webdav00.iptesting.jp/pqr-test_ch11/live.mpd", "network": "2a62e295-f305-4d98-b6bb-237467f2221d", "access_type": "MPEG-DASH" } ] }
Response
{ "data": { "uuid": "76be3fcc-4041-4456-9f92-c785ed37cf63", "id": "18", "note": "mpeg_dash_edited", "created": "2022-02-08T05:15:32.734Z", "modified": "2022-02-08T05:31:37.298Z", "entries": [ { "label": "mpeg_dash_new_edited", "source": "https://webdav00.iptesting.jp/pqr-test_ch11/live.mpd", "network": "2a62e295-f305-4d98-b6bb-237467f2221d", "access_type": "MPEG-DASH" } ] }, "metadata": {} }
POST channels/scan/config
Resource Information
Requires Authentication? | |
Response Formats | json |
HTTP Methods | POST |
Add a new scan, configured according to the attached data request.
Resource URL
https://{{ip_address}}:{{port}}/api/{{version}}/channels/scan/config
Example Request
POST
Body
{ "note": "mpeg_dash_NEW", "entries": [ { "label": "mpeg_dash_new", "source": "https://webdav00.iptesting.jp/pqr-test_ch11/live.mpd", "network": "2a62e295-f305-4d98-b6bb-237467f2221d", "access_type": "MPEG-DASH" } ] }
Response
{ "data": { "uuid": "76be3fcc-4041-4456-9f92-c785ed37cf63", "id": "18", "note": "mpeg_dash_NEW", "created": "2022-02-08T05:15:32.734Z", "modified": "2022-02-08T05:15:32.734Z", "entries": [ { "label": "mpeg_dash_new", "source": "https://webdav00.iptesting.jp/pqr-test_ch11/live.mpd", "network": "2a62e295-f305-4d98-b6bb-237467f2221d", "access_type": "MPEG-DASH" } ] }, "metadata": {} }
POST channels/scan/config multi
Resource Information
Requires Authentication? | |
Response Formats | json |
HTTP Methods | POST |
Add multiple scan, configured according to the attached data request.
Resource URL
https://{{ip_address}}:{{port}}/api/{{version}}/channels/scan/config
Example Request
POST
Body
{ "data": [ { "note": "multi_mpeg_dash1", "entries": [ { "label": "mpeg_dash_new", "source": "https://webdav00.iptesting.jp/pqr-test_ch111/live.mpd", "network": "2a62e295-f305-4d98-b6bb-237467f2221d", "access_type": "MPEG-DASH" } ] }, { "note": "multi_mpeg_dash2", "entries": [ { "label": "HLS", "source": "https://webdav00.iptesting.jp/pqr-test_ch1222/live.mpd", "network": "2a62e295-f305-4d98-b6bb-237467f2221d", "access_type": "HLS" } ] } ] }
Response
{ "data": [ { "uuid": "d3b4fe05-5263-4d2a-a689-f51653c7b04b", "id": "24", "note": "multi_mpeg_dash1", "created": "2022-02-23T15:03:33.252Z", "modified": "2022-02-23T15:03:33.252Z", "entries": [ { "label": "mpeg_dash_new", "source": "https://webdav00.iptesting.jp/pqr-test_ch111/live.mpd", "network": "2a62e295-f305-4d98-b6bb-237467f2221d", "access_type": "MPEG-DASH" } ] }, { "uuid": "687cc0d5-f999-419a-a3f4-3e5937e82421", "id": "25", "note": "multi_mpeg_dash2", "created": "2022-02-23T15:03:33.252Z", "modified": "2022-02-23T15:03:33.252Z", "entries": [ { "label": "HLS", "source": "https://webdav00.iptesting.jp/pqr-test_ch1222/live.mpd", "network": "2a62e295-f305-4d98-b6bb-237467f2221d", "access_type": "HLS" } ] } ], "metadata": {} }
PUT channels/scan/config multi
Resource Information
Requires Authentication? | |
Response Formats | json |
HTTP Methods | PUT |
Edit multiple scan, configured according to the attached data request.
Resource URL
https://{{ip_address}}:{{port}}/api/{{version}}/channels/scan/config
Example Request
PUT
Body
{ "data": [ { "uuid": "d3b4fe05-5263-4d2a-a689-f51653c7b04b", "id": "24", "note": "multi_mpeg_dash1_edited", "entries": [ { "label": "mpeg_dash_new_edited", "source": "https://webdav00.iptesting.jp/pqr-test_ch111/live.mpd", "network": "2a62e295-f305-4d98-b6bb-237467f2221d", "access_type": "MPEG-DASH" } ] }, { "uuid": "687cc0d5-f999-419a-a3f4-3e5937e82421", "id": "25", "note": "multi_mpeg_dash2_edited", "entries": [ { "label": "HLS_edited", "source": "https://webdav00.iptesting.jp/pqr-test_ch1222/live.mpd", "network": "2a62e295-f305-4d98-b6bb-237467f2221d", "access_type": "HLS" } ] } ], "metadata": {} }
Response
{ "data": [ { "uuid": "d3b4fe05-5263-4d2a-a689-f51653c7b04b", "id": "24", "note": "multi_mpeg_dash1_edited", "created": "2022-02-23T15:03:33.252Z", "modified": "2022-02-23T15:05:12.359Z", "entries": [ { "label": "mpeg_dash_new_edited", "source": "https://webdav00.iptesting.jp/pqr-test_ch111/live.mpd", "network": "2a62e295-f305-4d98-b6bb-237467f2221d", "access_type": "MPEG-DASH" } ] }, { "uuid": "687cc0d5-f999-419a-a3f4-3e5937e82421", "id": "25", "note": "multi_mpeg_dash2_edited", "created": "2022-02-23T15:03:33.252Z", "modified": "2022-02-23T15:05:12.359Z", "entries": [ { "label": "HLS_edited", "source": "https://webdav00.iptesting.jp/pqr-test_ch1222/live.mpd", "network": "2a62e295-f305-4d98-b6bb-237467f2221d", "access_type": "HLS" } ] } ], "metadata": {} }
DELETE channels/scan/config multi
Resource Information
Requires Authentication? | |
Response Formats | json |
HTTP Methods | DELETE |
Delete multiple scan configuration.
Resource URL
https://{{ip_address}}:{{port}}/api/{{version}}/channels/scan/config
Example Request
DELETE
Body
{ "data": [ "d3b4fe05-5263-4d2a-a689-f51653c7b04b", "687cc0d5-f999-419a-a3f4-3e5937e82421" ] }
Response
{ "data": { "success": true }, "metadata": {} }
- No labels