Reinstating SUS

Note: This command is not REST-compliant.

If a license key has an expired SUS, it can be reinstated with the reinstate-sus command. If SUS was presented as a separate item (key billable component), it will be re-created with an external ID.

Signature

Request:

  • URL: /30/keys/<KEY_ID_OR_ACTIVATION_CODE>/reinstate-sus
  • Method: POST
  • Body: no
  • Optional query string parameters:
    • return-key-state (boolean). Defines whether to return the Partner API 3.0's License Key Structure of a reinstated key in the response (false by default).
    • externalId (string). An optional parameter that is used as an external ID when the reinstate operation creates a new item (key billable component).

Response:

  • Success status code: 200
  • Body: Partner API 3.0's License Key Structure. The body is not empty if the return-key-state parameter was enabled.
Example

Get key state

Request:

GET /30/keys/12345678 HTTP/1.1

Response:

HTTP/1.1 200 OK

{
  "keyIdentifiers" : {
    "keyId" : 12345678,
     ...
  }
  "items" : [ {
    "externalId" : 123123,
    "item" : "PLESK-12-WEB-ADMIN-1M"
  } ],
  ...
  "susExpirationDate" : "2013-06-16T00:00:00.000Z",
  "susStatus" : "EXPIRED",
  ... 
}

Reinstate SUS

Request:

POST /30/keys/12345678/reinstate-sus?return-key-state=yes HTTP/1.1

Response:

HTTP/1.1 200 OK

{
  "ownerId" : "12345",
  "keyIdentifiers" : {
    "keyId" : 12345678,
     ...
  "items" : [ {
    "externalId" : 123123,
    "item" : "PLESK-12-WEB-ADMIN-1M"
  } ],
  ...
  "susExpirationDate" : "2016-06-16T00:00:00.000Z",
  "susStatus" : "ACTIVE",
  ...
}

  

 

Leave your feedback on this topic here

If you have questions or need support, please visit the Plesk forum or contact your hosting provider.
The comments below are for feedback on the documentation only. No timely answers or help will be provided.