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¶
Get version and license information¶
- GET /version¶
Display your license allowance and current system usage.
Produces: - application/xml, application/json – VersionDocument
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.
Slave management and monitoring¶
Install slave license on master node¶
- PUT /license/slave¶
Query Parameters: - path – The name of the slave license file.
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: - application/xml, application/json – SlaveListDocument
List slave license status¶
- GET /license/slave/(id)¶
Returns information about the slave with the given id.
New in version 4.0.3.
Produces: - application/xml, application/json – SlaveDocument
Remove slave instance¶
- DELETE /license/slave/(id)¶
Removes the slave with the given id.
New in version 4.0.3.
List all installed slave licenses¶
- GET /license/slave/license¶
Returns the id and SlaveIdentifier of all installed slave license on a master
Produces: - application/xml, application/json – SlaveLicenseListDocument
List installed slave licenses by id¶
- GET /license/slave/license/{id}¶
Returns the detail of an installed slave license with the given id
Produces: - application/xml, application/json – SlaveLicenseDocument
Install or update slave connection string¶
- PUT /APInoauth/license/auth-info¶
Accepts: - application/xml, application/json – SlaveAuthInfoDocument
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.