Searching for License Keys

Signature

Request:

  • URL: /30/keys
  • Method: GET
  • Body: no
  • Optional query string parameters:
    • ip-address-binding (string). It is used to filter licenses by the IP address that a license key is bound to. Can be both IPv4 and IPv6.
    • nickname (string). It is used to filter licenses by an alias, custom tag, and other similar properties.
    • uid (string). It is used to filter licenses by the UID with which a license is activated.
    • product (string). It is used to filter licenses by product name aliases.
    • status (string). It is used to filter licenses by status. The allowed values are active, expired, expiring, terminated, suspended.
    • type (string). It is used to filter licenses by license type. The allowed values are master, trial, purchased, lease, lease1m, lease3m, lease6m, lease1y, lease2y, lease3y.
    • fraud (string). It is used to indicate that a license is detected as being used on multiple Plesk servers. The allowed value: multiuse.
    • restrict-ip-binding (boolean) - It is used to indicate whether a license key can (false) or cannot (true) be used on IP addresses other than the IP address it is bound to. The allowed values: false, true.

Response:

Example

Request:

GET /30/keys?nickname=plesk213 HTTP/1.1

Response:

HTTP/1.1 200 OK
  
[
  {
    "ownerId" : "987654321",
    "keyId" : 1234567,
    "parentKeyId" : null
  }
]
 

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.