License

 

Resource Root

https://localhost:8443/api/rest/config/licenses

Summary

Resources

Methods

https://localhost:8443/api/rest/config/licenses/refresh-licenses

POST   Instructs the MCU to contact the license server to check for an update of the license.

This method does not block await the licensing server answer indefinitely, but returns immediately after notifying the client to update the license.

https://localhost:8443/api/rest/config/licenses/authority-config

PUT     Configures the licensing authority.

https://localhost:8443/api/rest/config/licenses/license-status

GET     Returns the license status and associated features associated with this product

 

Resources

https://localhost:8443/api/rest/config/licenses/refresh-licenses

Methods

POST

Instructs the product to contact the license server to check for an update to the license. This method does not block waiting for the product to contact the license server but instead returns immediately after notifying the client to perform an update to the license.  

 

Response

Status

Representation

Description

204

 

MCU successfully instructed to contact the licensing server for a license update..

401

application/vnd.plcm.plcm-error+xml

Invalid credentials

403

application/vnd.plcm.plcm-error+xml

Unable to get permission. Refreshing license requires administrator role.

 

 

 

https://localhost:8443/api/rest/config/licenses/authority-config

Methods

PUT

Configures the license authority.

Request

Representations: application/vnd.plcm-plcm-license-authority-config+xml

 

Response

Status

Representation

Description

204

 

MCU successfully instructed in contacting the licensing server.

401

application/vnd.plcm.plcm-error+xml

Invalid credentials

403

application/vnd.plcm.plcm-error+xml

Unable to get permission. Setting license authority configuration requires administrator role.

412

application/vnd.plcm.plcm-error+xml

ETag value is out of date or does not match request body.

428

application/vnd.plcm.plcm-error+xml

ETag value not supplied in header.

 

 

https://localhost:8443/api/rest/config/licenses/license-status

Methods

GET

Returns the license status and other attributes/features associated with the MCU.  

 

Response

Status

Representation

Description

200

application/vnd.plcm.plcm-license-status+xml

The license status and the associated MCU attributes.

401

application/vnd.plcm.plcm-error+xml

Invalid credentials

403

application/vnd.plcm.plcm-error+xml

Unable to get permission. Retrieving license status requires administrator role.