Hyperdeck REST Protocol

Questions about ATEM Switchers, Camera Converter and everything live!
  • Author
  • Message
Offline

DylanReeve

  • Posts: 12
  • Joined: Sun Sep 22, 2013 10:34 am

Hyperdeck REST Protocol

PostTue Apr 30, 2024 10:04 am

Version 8.4 has apparently introduced a REST API protocol, which looks very useful.

But despite having a pretty detailed protocol description in the manual, there are no details on connections or base URL.

The open ports on my test machine after the 8.4 upgrade are the expected ones: 21 (FTP), 80 (HTTP), 443 (HTTPS) and 9993 (HyperDeck Ethernet Protocol)

Neither the HTTP or HTTPS ports seem to expose the REST endpoints.

There is also a port open on 5357 which is a separate HTTP server, but http://[ipaddress]:5357/system returns a 404 as does every other REST endpoint I try. So I'm guessing this is the right port, but is there a path?

Similarly, the manual details a websocket notification protocol, but I'm unable to establish a WS connection to any of the open ports.

Is there more information available? Or are these features not yet enabled?
Offline

Howard Roll

  • Posts: 2632
  • Joined: Fri Jun 03, 2016 7:50 am

Re: Hyperdeck REST Protocol

PostTue Apr 30, 2024 5:47 pm

The hyperdeck manual seems to be missing some information. In the Camera API it's a little more clear how the HTTP request formatting and communication works.

API.png
API.png (158.73 KiB) Viewed 285 times


My camera's name is M4K1 so the HTTP command formatting would look like this. No idea if it will work for the Hyperdeck but it might get you headed in the right direction.

Rest.png
Rest.png (62.72 KiB) Viewed 285 times


Good Luck
Offline

DylanReeve

  • Posts: 12
  • Joined: Sun Sep 22, 2013 10:34 am

Re: Hyperdeck REST Protocol

PostTue Apr 30, 2024 7:15 pm

Great detective work!

That is indeed the endpoint for the API - http://[IP Address]/control/api/v1/[Command]

Screenshot 2024-05-01 071327.png
Screenshot 2024-05-01 071327.png (10.56 KiB) Viewed 265 times

Return to Live Production

Who is online

Users browsing this forum: No registered users and 35 guests