Avid NEXIS Management API

Appearance

Users ​

Get all users ​

GET /users Get all users in the Avid NEXIS system.

Request Example:

bash
curl --location '{{url}}/users' \
--header 'token;'

Get an user by Id ​

GET /users/userId Get an user by Id.

Request Example:

bash
curl --location '{{url}}/users/1' \
--header 'token;'

Create an user ​

POST /users Create a user.

Required parameters for creating a new user are name, password, and verifyPassword.

Request Example:

bash
curl --location '{{url}}/users' \
--header 'token;' \
--header 'Content-Type: application/json' \
--data '{
    "name": "test",
    "password": "t3mpPwd$",
    "verifyPassword": "t3mpPwd$",
    "bandwidthLimit": 100
}'

Update an user by Id ​

PUT /users/userId Update an user by Id.

Request Example:

bash
curl --location --request PUT '{{url}}/users/{{id}}' \
--header 'token;' \
--header 'Content-Type: application/json' \
--data '{
    "name": "test"
}'

Delete an user by user Id ​

DELETE /users/userId Delete an user.

Request Example:

bash
curl --location --request DELETE '{{url}}/users/{{id}}' \
--header 'token;'

Change Administrator password ​

PUT /adminpwd Change Administrator password.

Required parameters for changing the Adminstrator password are old, new, and verify.

Request Example:

bash
curl --location --request PUT '{{url}}/adminpwd' \
--header 'Content-Type: application/json' \
--header 'token: <token value>' \
--data '{ 
    "old": "currentPassword",
    "new": "newPassword",
    "verify": "verifyPassword"
}'

Useful References ​

Avid NEXIS Official Documentation