Network Optix Nx Meta APIs and SDKs
Choose the Nx interface for server access, client integration, device support or analytics. Record the product version and supported SDK or API capabilities.
Sources and scopeSource record 25 August 2026
Technical source record: 25 August 2026. Check the linked documentation for current product requirements.
Public Nx Meta developer and release documentation reviewed on 25 August 2026; OEM branding, exact server/API/SDK compatibility, credentials, licences, cloud region, build flags, and endpoint behaviour require the target release contract.
On this page
Overview#
Vendor APIs / VMS and cloud video / Network Optix
Network Optix publishes several distinct developer surfaces through Nx Meta: the VMS Server HTTP REST API, a native C++ Server Plugin SDK, a Cloud API, and the source available/open source desktop client route. Nx technology is also OEMed; product branding alone isn't a compatibility contract. Confirm the OEM release and enabled APIs with its supplier.
Documented interface map#
| Surface | Documented capability | Boundary |
|---|---|---|
| Server HTTP REST API | Resource/user management, live and recorded video, events/rules, PTZ and server functions | Installed server exposes its own Swagger/reference; API groups include newer, legacy and deprecated contracts |
| C++ Server Plugin SDK | Metadata, video source and storage plugins | Native package must match supported server release/toolchain and licence |
| Cloud API | Cloud account/system integration | Cloud programme, identity, tenant and region constraints apply |
| Open source desktop client | Builds/customizes the Nx desktop client under published terms | Client source does not grant server/cloud APIs, licences, branding or support |
Release and API version boundary#
The official release page listed Nx Meta VMS 6.1.2.42921, published 20 May 2026, when reviewed on 25 August 2026. This dated observation is useful for source tracking only. OEM releases can lag, branch or rename components; use the build and SDK package supplied for the deployed product.
Nx documentation distinguishes new, legacy and deprecated REST API groups. Don't start new code on a legacy route because an old sample is easier to find. Retrieve the API description from the target server/build, pin the operation/schema version, and monitor deprecation/release notes for breaking changes.
Authentication and authorisation#
Use the authentication mechanism documented by the exact server or Cloud API release. Protect credentials/tokens outside source and logs, require HTTPS with verified identity, and assign a dedicated least privileged account. Separate system/user administration from camera view, playback, export, PTZ, rules and event access.
Don't expose a server’s interactive API reference outside its management boundary or enable permissive cross origin access to simplify a browser integration. A cloud identity and a local VMS user can have different authorities and lifecycles.
REST integration contract#
- Discover the target build and supported API description at connection/commissioning time.
- Pin serialisation types and treat identifiers as opaque.
- Use documented pagination/filtering; don't assume a full collection fits one response.
- Bound downloads, time ranges, media concurrency and response sizes.
- Distinguish current configuration, current operational state, and historical events.
- Reconcile resources, users, event rules and active streams after reconnect or failover.
- Treat media URLs, session tokens and exported footage as secrets/sensitive evidence.
For PTZ, I/O, rules or configuration commands, implement authorisation and uncertain outcome handling. An HTTP success doesn't demonstrate camera movement, recording, analytics execution or a physical output.
C++ plugin boundary#
Server plugins execute close to media and VMS state. Follow the exact SDK’s ABI, compiler, platform, threading, callback, buffer ownership and lifecycle contract. Validate all metadata and media dimensions, timestamps and lengths. Bound queues and return from callbacks promptly. A crash or leak can affect recording availability, so isolate risky codecs/parsers and provide controlled disable/rollback.
Developer licences are available through the official developer process, but they aren't production entitlements. Record expiry, feature limits and the production licensing path.
Lifecycle and compatibility#
Monitor release notes for REST changes, SDK package rebuild requirements and deprecated APIs. Maintain separate compatibility records for Nx Meta reference releases and every OEM distribution.
Primary sources#
- Nx Meta developer documentation, official surface catalogue.
- Developer overview, programme and architecture entry point.
- Server HTTP REST API, documented capability and API generation boundary.
- Nx Meta releases, dated product and SDK packages.
- Developer licences, non production licence route.
- Open source desktop client, separate client source boundary.