Please publish the VIGI NVR OpenAPI spec / Postman collection

Please publish the VIGI NVR OpenAPI spec / Postman collection

Please publish the VIGI NVR OpenAPI spec / Postman collection
Please publish the VIGI NVR OpenAPI spec / Postman collection
Yesterday - last edited Yesterday
Model: VIGI NVR4032H  
Hardware Version:
Firmware Version: 1.4.1 Build 250921 Rel.47137n

Hello TP-Link team,

I am using VIGI NVR4032H and I would like to request the official OpenAPI specification, documentation, or a Postman collection for the VIGI NVR OpenAPI.

Your FAQ clearly mentions that the OpenAPI exists and can be used to call NVR API interfaces, but there is no public specification or downloadable documentation available.

This is very confusing for developers and system integrators because the feature is advertised but not discoverable.

Over the past year, many developers have been asking the same question in the community and still cannot find the documentation.


Why this matters

We are building automation and analytics around VIGI cameras and NVRs. Today we rely on ONVIF and RTSP, but those protocols only expose a small subset of what the VIGI app can actually do.

For example:

  • Smart events and AI analytics

  • Alarm and webhook integrations

  • Device management automation

  • Audio and advanced features only available in the app

These capabilities clearly exist internally, but without OpenAPI documentation they cannot be integrated into real systems.

 

Real world story

We recently deployed VIGI cameras for a small warehouse and retail chain.

They loved the hardware and the pricing. The next step was to integrate:

  • access control

  • alarm system

  • inventory system

  • AI analytics

The decision point came down to one simple question from management:

"Can it integrate with our software?"

We know the OpenAPI exists, but without documentation we cannot confidently build on it. This creates hesitation when recommending VIGI for larger deployments.

If the API were public, this project would already be scaled to multiple locations.

 

Why publishing the API helps TP-Link grow

Open APIs do not reduce hardware sales. They increase them.

When developers can integrate easily:

  • VIGI becomes part of larger ecosystems

  • Integrators recommend the platform more often

  • Community builds plugins and integrations

  • Lock in happens at the platform level, not just hardware

Companies like Axis, Hikvision, Ubiquiti and Reolink benefit massively from developer ecosystems.

When developers can build integrations, your hardware becomes the default choice.

Right now the OpenAPI feels like it is available only to bulk purchasers or private partners. Making at least the core API publicly accessible would unlock a huge developer community.

 

What I am requesting

Please publish one of the following:

  1. OpenAPI / Swagger spec (best option)

  2. Developer documentation portal

  3. Postman collection

  4. Even a "starter" subset of endpoints would help

  5. If all you have is a Word document or PDF that works too- anything is better than nothing
     

This single step would dramatically increase adoption and trust in the VIGI platform.

Many of us want to build on VIGI. We just need the documentation to start.

 

Thank you 🙏

  0      
  0      
#1
Options
1 Accepted Solution
Re:Please publish the VIGI NVR OpenAPI spec / Postman collection-Solution
Yesterday - last edited Yesterday

Hi  @PriyankP 

Thanks for posting in our business forum.

You may refer to the attachment for reference.

File:
VIGI NVR Open API Document 1.pdfDownload
Best Regards! >> Omada EAP Firmware Trial Available Here << >> Get the Latest Omada SDN Controller Releases Here << *Try filtering posts on each forum by Label of [Early Access]*
Recommended Solution
  1  
  1  
#2
Options
2 Reply
Re:Please publish the VIGI NVR OpenAPI spec / Postman collection-Solution
Yesterday - last edited Yesterday

Hi  @PriyankP 

Thanks for posting in our business forum.

You may refer to the attachment for reference.

File:
VIGI NVR Open API Document 1.pdfDownload
Best Regards! >> Omada EAP Firmware Trial Available Here << >> Get the Latest Omada SDN Controller Releases Here << *Try filtering posts on each forum by Label of [Early Access]*
Recommended Solution
  1  
  1  
#2
Options
Re:Please publish the VIGI NVR OpenAPI spec / Postman collection
11 hours ago - last edited 11 hours ago

@Hank21 Thanks, this is great. I'll take some time to absorb this.

  0  
  0  
#3
Options