You are viewing an old version of this page. View the current version.
Compare with Current View Page History
« Previous Version 3 Current »
Requires Authentication?
Yes
Response Formats
json
HTTP Methods
GET
Returns a list of all PTP in the system, with its main configuration data.
https://{{ip_address}}:{{port}}/api/{{version}}/ptp/config
https://192.168.0.22/api/5.0/ptp/config
{ "data": [ { "uuid": "a3dc546f-d18a-4b37-96fe-44dcca5cf14f", "label": "PTP", "working_mode": "Unicast", "network": null, "domain": 127, "modified": "2021-07-04T07:46:08.869Z", "created": "2021-07-04T07:46:08.869Z" }, { "uuid": "23bcd716-8ed2-4f21-9137-236ca059dbb7", "label": "test_PTP", "working_mode": "Multicast", "network": "bbfd98b1-f141-41e2-90d7-83771d10b2a4", "domain": 127, "modified": "2021-09-21T05:33:03.524Z", "created": "2021-09-21T05:33:03.524Z" } ], "metadata": { "item_count": 2, "total_items": 2, "current_page": 1, "sort_by": [ { "field": "label", "direction": "ASC" } ], "links": { "current": "https://192.168.0.22/api/5.0/ptp/config" } } }
Returns an extended single PTP configuration view, specified by the required {uuid} parameter.
https://{{ip_address}}:{{port}}/api/{{version}}/ptp/config/{{uuid}}
Parameter
Data Type
Description
uuid(required)
string
The UUID of the desired encoder.
https://192.168.0.22/api/5.0/ptp/config/23bcd716-8ed2-4f21-9137-236ca059dbb7
{ "data": [ { "uuid": "23bcd716-8ed2-4f21-9137-236ca059dbb7", "label": "test_PTP", "created": "2021-09-21T05:33:03.524Z", "modified": "2021-09-21T05:33:03.524Z", "network": "bbfd98b1-f141-41e2-90d7-83771d10b2a4", "working_mode": "Multicast", "domain": 127 } ], "metadata": {} }
Returns all meta data used by PTP configuration.
https://{{ip_address}}:{{port}}/api/{{version}}/ptp/config/meta
https://192.168.0.22/api/5.0/ptp/config/meta
{ "WorkingModes": [ "Unicast", "Multicast" ] }
DELETE
Delete a specific PTP configuration.
The UUID of the output to be deleted.
{ "data": [ { "success": true } ], "metadata": {} }
PUT
Edit a PTP configuration.
byte
The UUID of the encoder to be edited.
https://192.168.0.22/api/5.0/ptp/config/b84fd266-2f3d-4c36-9941-0466f68d2696
Body
{ "label": "PTP III_edited", "network": "bbfd98b1-f141-41e2-90d7-83771d10b2a4", "working_mode": "Unicast", "domain": 0 }
Response
{ "data": [ { "uuid": "b84fd266-2f3d-4c36-9941-0466f68d2696", "label": "PTP III_edited", "created": "2021-09-21T05:40:11.246Z", "modified": "2021-09-21T05:42:29.485Z", "network": "bbfd98b1-f141-41e2-90d7-83771d10b2a4", "working_mode": "Unicast", "domain": 0 } ], "metadata": {} }
POST
Add a new PTP, configured according to the attached data request.
{ "label": "PTP III", "network": null, "working_mode": "Unicast", "domain": 127 }
{ "data": [ { "uuid": "b84fd266-2f3d-4c36-9941-0466f68d2696", "label": "PTP III", "created": "2021-09-21T05:40:11.246Z", "modified": "2021-09-21T05:40:11.246Z", "network": "Auto", "working_mode": "Unicast", "domain": 127 } ], "metadata": {} }
