Avid NEXIS Management API

Appearance

Getting Started ​

To get started with your Avid NEXIS | Management API, you need to have an Avid NEXIS with a system license and an API license.

The system license can be activated via any of the following methods:

  • online activation
  • download the license file for offline activation
  • modular license activation for perpetual entitlement

Online activation requires your network configuration's TCP port 3443 to be open.

Avid NEXIS API license entitlement is valid per system. It can be perpetual or subscription based.

The API endpoints assume that the base URL consisted of the Avid NEXIS IP address and necessary prefix such as https://nexis_ip_address/nxapi/v1/login.

🗒️ Notes:

  • https:// needs to be at the beginning of the base URL for each API call.
  • The API path and specification is for Avid NEXIS 2025.2 build or later version.

API rate limit is 5000 requests per min for each IP address.

Avid NEXIS can be an on-premise or cloud system. The following is an overview for each setup.

On-Premises System ​

  1. Register the NEXIS and redeem the activation code
  2. Download the installer kit to set up and configure the Agent at 169.254.10.10:5015
    • Use the last 8 characters of the Avid NEXIS controller's serial number as initial password to log into Agent
    • Install a new Avid NEXIS build using the NEXISSetup_version.bin file from the installer kit
    • Enter the date, time, engine, network, and other necessary information in the Agent
    • Update the initial password after making necessary changes
  3. For new systems, create a File System
  4. Activate the license

Cloud System ​

The Avid NEXIS software-defined storage system provides a high-performance distributed file system that contains high-capacity shared media storage for workgroups of connected devices.

Instructions and deployment templates are available at the following Avid NEXIS pages:

Amazon AWS: ​

Azure: ​

Official Page: ​