License

The license resource allows you to view and update your Vidispine license. It is also the entry point to use if the system is being used as a licensing provider.

Version and license

Retrieve version and license information

GET /version

Display your license allowance and current system usage.

The systemInfo element in the response shows the MAC addresses discovered on the local system. The MAC-address(es) in the license key must match that/those of your system.

Produces:
  • application/xml, application/jsonVersionDocument
  • text/plain – The version details in a informational text format.

Retrieve the license file

GET /license

Retrieves the contents of the installed license file.

Produces:
  • text/plain – The contents of the license file.

Slave management and monitoring

Install a slave license on a master node

PUT /license/slave

Installs the slave license file with the given path.

Query Parameters:
 
  • path (string) – Required. The name of the slave license file.
Produces:

Install a slave license on a master node

POST /license/slave

Installs a slave license.

Accepts:
  • text/plain – The content of the slave license file.
Produces:

List all slaves

GET /license/slave

Returns a list of all the slave nodes connected to this master. Slaves that have not been seen for more than 180 minutes will not be available.

Produces:

List slave license status

GET /license/slave/(id)

Returns information about the slave with the given id.

Produces:

Retrieve a slave license file

GET /license/slave/(id)/license

Returns the slave license for a specific slave.

Produces:

Delete a slave instance

DELETE /license/slave/(id)

Removes the slave with the given id.

List all installed slave licenses

GET /license/slave/license

Returns the id and SlaveIdentifier of all installed slave license on a master

Produces:

List installed slave licenses by id

GET /license/slave/license/(id)

Returns the detail of an installed slave license with the given id

Produces:

Install or update slave connection string

PUT /APInoauth/license/auth-info
Accepts:

Example

PUT /APInoauth/license/auth-info
Content-Type: application/xml

<SlaveAuthInfoDocument xmlns="http://xml.vidispine.com/schema/vidispine">
  <masterHost>http://192.168.0.1:8080/</masterHost>
  <masterHost>http://my.other.server:8080/</masterHost>
  <slaveId>your-slave-id</slaveId>
</SlaveAuthInfoDocument>

License validity and status can be seen from GET /version.