Wowza Community

Documentation offline

I’m expanding the ways our media platform interacts with Wowza through the REST API, so I’m doing fewer manual tasks as we grow our client base. It would be fantastic to have access to REST API documentation when I am offline or otherwise unable to access one of our cloud-based servers. I’ve considered the following and none are good options.

  • Spin up our expensive GPU instances at AWS every time I need to work on our integration. This is costly, and also means I need to keep ports open for docs (which I’m not particularly confident in). It also means I have to open them selectively for wherever I happen to be (home, office, various coffee shops, hotel on the road, etc.) or leave them open to all IPs. Neither of those is a workable plan.
  • Install and run Streaming Engine locally on my Macbook Pro, and access docs from there. I have installed it but realized that if I fire it up locally, the license server will record me as a new instance, and now I’m paying another license fee just to access docs. It’s worse than that - wherever I am, I will have a different IP address and each will count as a new instance with Wowza, so this could get out of hand very quickly, just to access documentation for an hour here or there.
  • Manually mine the code to try to pull out REST API calls, object structure, etc. This is I guess next on my list.

Is there really no way to get a local-only copy of documentation for the REST API? Is there no way to run Streaming Engine locally with only the document server on, in a way that does not report back to the license server and hit me for a big bill? Is there a way to dump all of the doc data in JSON or XML or something and then point the really nice document browser at that static source?

Hi,

providing the REST API documentation through our developer portal is on the roadmap, but with no fixed date yet.

You might want to give this procedure to run the documentation server through Postman a try though:

https://www.wowza.com/docs/how-to-access-wowza-streaming-engine-rest-api-reference-documentation-with-postman

Regards,
Bernd Backhaus
Wowza Support
WOWZA | The solution you start with, the partner you scale with.

Wowza Video is here! Look at all the new features that will help elevate your business.

Manage your Support cases online
Bookmark our FAQ page
Bookmark our Status page