Is the Nx Cloud up? Visit our Status Page for the current health and performance of the Nx Cloud.

Status Page

Accessing the HTTP REST API

Nx Support
Updated

The Media Server REST API provides a standardized set of HTTP endpoints to integrate Media Server with third-party systems. Because the API is language-agnostic, you can interact with the server using any programming language or tool that supports standard HTTP requests (GET, POST, PUT, PATCH, and DELETE).

The API allows you to manage nearly every feature in the Media Server, including:

  • Resources: Query and manage systems, servers, cameras, and users.

  • Permissions: Manage user roles and access levels.

  • Video: Stream live or recorded video from the system.

  • Logic: Generate events and create automation rules.

  • Control: Manage PTZ cameras and other hardware.

View the API documentation

You can access the API documentation in three ways. We recommend using a local method to ensure the documentation matches your specific server version.

Method 1: Use the WebAdmin interface (Recommended)

If you have the Media Server installed, you can access the interactive API documentation directly in your browser:

Go to http://<server_ip>:<server_port>/#/api-tool/main

For example: https://localhost:7001/#/api-tool/main

Method 2: Download the OpenAPI schema

If you use tools like Postman, Insomnia, or your preferred AI agents, download and save the raw OpenAPI JSON file from your local server:

  1. Open your browser and go to https://localhost:7001 (or your server's IP address).

  2. Log in with your administrator credentials.

  3. Open a new tab and go to http://localhost:7001/web/static/openapi_v4.json.

  4. Right-click the page and select Save Page As....

  5. Save the file with a .json extension.

Method 3: View online documentation

You can view the latest version of the documentation on the Media Server API website:

Online OpenAPI

Test API endpoints

You can test endpoints and inspect real-time responses directly in your browser or through third-party tools.

Test in the WebAdmin interface

  1. Navigate to the API endpoint you want to test in the WebAdmin interface.

  2. Click Try it out to unlock the input fields.

  3. Enter your parameters.

  4. Click Execute to send the request to the server.

The interface displays the full cUrl command, the request URL, and the formatted JSON response body.

NOTE: For endpoints that return large datasets, the WebAdmin interface might load slowly. For better performance with large payloads, copy the cUrl command or request URL into an external tool like Postman or Insomnia.

 

Related articles

Comments

0 comments

Article is closed for comments.