Creating a License Key

Signature

Request:

  • URL: /30/keys
  • Method: POST
  • Body: Partner API 3.0's License Key Structure
  • Optional query string parameters:
    • return-key-state (boolean). Defines whether to return the Partner API 3.0's License Key Structure of a created key in the response (false by default).

Warning: This command does not yet support the parameters that users enter when they buy licenses, such as "Capacity in 100GB blocks" (used for Virtuozzo storage licenses). Also, this command supports only Partner API 3.0 constants. It does not support Partner API 1.0 constants.

Response:

  • Success status code: 201
  • Header: "Location" with an URL pointing exactly to the created key
  • Body: Partner API 3.0's License Key Structure. Not empty if the return-key-state parameter was enabled.
Example

Request:

POST /30/keys?return-key-state=yes HTTP/1.1
  
{
  "items" : [ {
    "externalId" : "98765",
    "item" : "PLESK-12-WEB-ADMIN-1M",
  },
  {
    "externalId" : "54321",
    "item" : "FT-PLESK-5-LANGUAGE-PACKS-1M"
  } ]
}

Response:

HTTP/1.1 201 Created
Location: https://api.central.plesk.com/30/keys/12345678
  
{
  "ownerId" : "12345",
  "keyIdentifiers" : {
    "keyId" : 12345678,
    ...
}

  

 

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.