Versions Compared
| Version | Old Version 1 | New Version Current |
|---|---|---|
| Changes made by | ||
| Saved on |
Key
- This line was added.
- This line was removed.
- Formatting was changed.
GET channels/paths/config
Resource Information
Requires Authentication? | |
Response Formats | json |
HTTP Methods | GET |
Returns a list of all channel path configurations in the system, with its main configuration data.
Resource URL
https://{{ip_address}}:{{port}}/api/{{version}}/channels/paths/config
Example Request
GET
| Code Block | ||
|---|---|---|
| ||
{
"data": [
{
"uuid": "1a609825-5168-4141-9e9f-cdd9021a85e3",
"label": "path_testing",
"created": "2023-07-24T13:50:47.209Z",
"modified": "2023-10-11T07:31:02.411Z",
"nodes": [
{
"channel": "386f1d52-4e2b-4db8-9bf9-aab1d8f40283",
"x": 200,
"y": 352,
"sources": []
},
{
"channel": "ce697677-007c-4491-8dfc-a5bfe067a18b",
"x": 474,
"y": 255,
"sources": [
{
"channel": "386f1d52-4e2b-4db8-9bf9-aab1d8f40283",
"label": "path_4",
"expected_latency": 200
}
]
},
{
"channel": "821c811f-6c62-423a-9eb3-dd3f8661b37f",
"x": 472,
"y": 353,
"sources": [
{
"channel": "386f1d52-4e2b-4db8-9bf9-aab1d8f40283",
"label": "path_4",
"expected_latency": 200
}
]
},
{
"channel": "206c9e47-66b4-45d2-b2cf-9c5f76a13b50",
"x": 476,
"y": 456,
"sources": [
{
"channel": "386f1d52-4e2b-4db8-9bf9-aab1d8f40283",
"label": "path_4",
"expected_latency": 200
}
]
},
{
"channel": "638991b5-bfa1-46f2-acde-ccd8599f51d9",
"x": 195,
"y": 124,
"sources": []
},
{
"channel": "16872ca2-4911-463f-ba54-9fc5c385bdf3",
"x": 431,
"y": 125,
"sources": [
{
"channel": "638991b5-bfa1-46f2-acde-ccd8599f51d9",
"label": "path_1",
"expected_latency": 200
}
]
},
{
"channel": "609d209b-8dc8-471f-8f9a-d50e442dc0b7",
"x": 671,
"y": 125,
"sources": [
{
"channel": "16872ca2-4911-463f-ba54-9fc5c385bdf3",
"label": "path_2",
"expected_latency": 200
}
]
}
]
},
{
"uuid": "6e97096f-fcf9-4ec2-9ada-7c4b3571d243",
"label": "path_test1",
"created": "2023-10-15T16:41:09.006Z",
"modified": "2023-10-15T16:41:09.006Z",
"nodes": [
{
"channel": "7822ee54-c5fe-4c5c-8223-3960c0bb245d",
"x": 108,
"y": 74,
"sources": []
}
]
},
{
"uuid": "03c5d99a-0e0d-41ab-a9e8-8bbb46e7edf8",
"label": "path_test2",
"created": "2023-10-15T16:41:45.461Z",
"modified": "2023-10-15T16:41:45.461Z",
"nodes": []
}
],
"metadata": {
"item_count": 3,
"total_items": 3,
"current_page": 1,
"sort_by": [
{
"modified": "ASC"
}
],
"links": {
"current": "http://192.168.10.142/api/5.1/channels/paths/config"
}
}
} |
GET channels/paths/config/{uuid}
Resource Information
Requires Authentication? | |
Response Formats | json |
HTTP Methods | GET |
Returns an extended single channel path configurations in the system, with its main configuration data.
Resource URL
https://{{ip_address}}:{{port}}/api/{{version}}/channels/paths/config/{{uuid}}
Example Request
GET
| Code Block | ||
|---|---|---|
| ||
{
"data": {
"uuid": "1a609825-5168-4141-9e9f-cdd9021a85e3",
"label": "path_testing",
"created": "2023-07-24T13:50:47.209Z",
"modified": "2023-10-11T07:31:02.411Z",
"nodes": [
{
"channel": "386f1d52-4e2b-4db8-9bf9-aab1d8f40283",
"x": 200,
"y": 352,
"sources": []
},
{
"channel": "ce697677-007c-4491-8dfc-a5bfe067a18b",
"x": 474,
"y": 255,
"sources": [
{
"channel": "386f1d52-4e2b-4db8-9bf9-aab1d8f40283",
"label": "path_4",
"expected_latency": 200
}
]
},
{
"channel": "821c811f-6c62-423a-9eb3-dd3f8661b37f",
"x": 472,
"y": 353,
"sources": [
{
"channel": "386f1d52-4e2b-4db8-9bf9-aab1d8f40283",
"label": "path_4",
"expected_latency": 200
}
]
},
{
"channel": "206c9e47-66b4-45d2-b2cf-9c5f76a13b50",
"x": 476,
"y": 456,
"sources": [
{
"channel": "386f1d52-4e2b-4db8-9bf9-aab1d8f40283",
"label": "path_4",
"expected_latency": 200
}
]
},
{
"channel": "638991b5-bfa1-46f2-acde-ccd8599f51d9",
"x": 195,
"y": 124,
"sources": []
},
{
"channel": "16872ca2-4911-463f-ba54-9fc5c385bdf3",
"x": 431,
"y": 125,
"sources": [
{
"channel": "638991b5-bfa1-46f2-acde-ccd8599f51d9",
"label": "path_1",
"expected_latency": 200
}
]
},
{
"channel": "609d209b-8dc8-471f-8f9a-d50e442dc0b7",
"x": 671,
"y": 125,
"sources": [
{
"channel": "16872ca2-4911-463f-ba54-9fc5c385bdf3",
"label": "path_2",
"expected_latency": 200
}
]
}
]
},
"metadata": {}
} |
POST channels/paths/config
Resource Information
Requires Authentication? | |
Response Formats | json |
HTTP Methods | POST |
Add a new channel paths, configured according to the attached data request.
Resource URL
https://{{ip_address}}:{{port}}/api/{{version}}/channels/paths/config
Example Request
POST
Body
| Code Block | ||
|---|---|---|
| ||
{
"data": {
"label": "path1_post",
"nodes": [
{
"channel": "206c9e47-66b4-45d2-b2cf-9c5f76a13b50",
"x": 816,
"y": 221,
"sources": [
{
"channel": "386f1d52-4e2b-4db8-9bf9-aab1d8f40283",
"label": "path_4",
"expected_latency": 200
}
]
},
{
"channel": "638991b5-bfa1-46f2-acde-ccd8599f51d9",
"x": 195,
"y": 124,
"sources": []
},
{
"channel": "16872ca2-4911-463f-ba54-9fc5c385bdf3",
"x": 506,
"y": 74,
"sources": [
{
"channel": "638991b5-bfa1-46f2-acde-ccd8599f51d9",
"label": "path_1",
"expected_latency": 200
}
]
}
]
}
} |
Response
| Code Block | ||
|---|---|---|
| ||
{
"data": {
"uuid": "0c3beced-d098-45d1-a424-9c44a25df74b",
"label": "path1_post",
"created": "2023-10-15T17:23:30.541Z",
"modified": "2023-10-15T17:23:30.541Z",
"nodes": [
{
"channel": "206c9e47-66b4-45d2-b2cf-9c5f76a13b50",
"x": 816,
"y": 221,
"sources": [
{
"channel": "386f1d52-4e2b-4db8-9bf9-aab1d8f40283",
"label": "path_4",
"expected_latency": 200
}
]
},
{
"channel": "638991b5-bfa1-46f2-acde-ccd8599f51d9",
"x": 195,
"y": 124,
"sources": []
},
{
"channel": "16872ca2-4911-463f-ba54-9fc5c385bdf3",
"x": 506,
"y": 74,
"sources": [
{
"channel": "638991b5-bfa1-46f2-acde-ccd8599f51d9",
"label": "path_1",
"expected_latency": 200
}
]
}
]
},
"metadata": {}
} |
DELETE channels/paths/config
Resource Information
Requires Authentication? | |
Response Formats | json |
HTTP Methods | DELETE |
Delete paths configuration.
Resource URL
https://{{ip_address}}:{{port}}/api/{{version}}/channels/paths/config/{{uuid}}
Example Request
DELETE
Response
| Code Block | ||
|---|---|---|
| ||
{
"data": {
"success": true
},
"metadata": {}
} |