Renewing a License Key

Note: This command is not REST-compliant.

Signature

Request:

  • URL: /30/keys/<KEY_ID_OR_ACTIVATION_CODE>/renew
  • Method: GET
  • Body: no
  • Optional query string parameters:
    • return-key-state (boolean). Determines whether to return Partner API's License Key Structure of a renewed license key in response (false by default).

Response:

  • Success status code: 200
  • Body: Partner API 3.0's License Key Structure (Not empty if the return-key-state parameter was enabled).
Example

Success scenario

Request:

GET /30/keys/12345678/renew?return-key-state=yes HTTP/1.1

Response:

HTTP/1.1 200 OK
  
{
  "ownerId" : "12345",
  "keyIdentifiers" : {
    "keyId" : 12345678,
     ...
}

  

Error scenario

The license key is terminated.

Request:

GET /30/keys/12345678/renew?return-key-state=yes HTTP/1.1

Response:

HTTP/1.1 400 Bad Request
  
{
  "code":"400",
  "type":"24204",
  "message":"The license key is detected as terminated. No further actions with this license key are allowed",
  "details":"Key number = PLSK.12345678.0001."
}

  

 

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.