This section describes parameters that you can use in a custom search query.

Parameter Description
id

The eight digits in the middle part of a license number.

Supported formats:

PLSK.01234567.0001

PLSK.01234567

1234567 (leading zeros can be omitted)

Examples:

id:2557864

id:(02637396, 02637397, 02637398)

code

A license activation code. If it contains hyphen signs (“-“), use double quotation marks when you specify the code.

For example: code:"AX1000-ABCDEF-123456-ABC123-DEF456"

product

The product name alias. Aliases are used instead of product names for a more convenient search. For the list of aliases refer to Product Name Aliases.

For example: product:pcs

type

The type of a license. Possible values: lease, purchased, trial, master.

Examples:

type:trial

type:(lease, trial)

keyinfo

The description of a license (the License information column in the list of licenses) that users cannot change.

For example: status:active type:trial keyinfo:"12 months"

desc

A short description of a license that is added by users.

Examples:

desc:"for the clients"

note

The text of a note assigned to a license.

Examples:

note:joe@example.com

note:"requested by James for testing"

status

The status of a license. Possible values: active, terminated, suspended, expired, expiring.

Examples:

status:active

status:(terminated, suspended, expired)

addon

This parameter is used to find licenses that have certain features. Features are attributes that you select when you purchase a license, such as the maximum number of domains or Plesk Power Pack support.

For example: addon:"30 Dom"

This search query finds licenses that have the features whose names contain the text “30 dom”. In other words, if a feature name contains “30 domains”, “230 domains”, “330 dom”, and so on, then the licenses that have this feature will be displayed in search results.

The addon parameter has an extension for specifying billing model, which allows to find leased or purchased features. You can add the extension by using the # sign. Currently, only the lease and purchased billing models are supported.

Examples:

addon:="tomcat server"#purchased

This query finds all licenses whose addon features have the name “tomcat server” and this feature is purchased.

addon:=["tomcat server"#purchased, "100 sites"#lease]

This query finds all licenses that have both the specified addon features, and the feature names exactly match the specified values. It also takes into account the billing model: It finds “tomcat server” feature that is purchased, and “100 sites” feature that is leased.

addon:("Premium Antivirus"#purchased, "cloudflare"#lease)

This query finds all licenses that have any of the specified addon features, and the feature names contain the specified values (exact matching is not necessary). It also takes into account the billing model: It finds “Premium Antivirus” that is purchased, and “cloudflare” that is leased.

You can specify the duration of lease:

  • lease1m - lease for a 1-month period
  • lease3m - lease for a 3-month period
  • lease6m - lease for a 6-month period
  • lease1y - lease for a 1-year period
  • lease2y - lease for a 2-year period
  • lease3y - lease for a 3-year period
  • lease - lease for any period

For example:

addon:"100 sites"#lease2y

This query finds all licenses whose addon features contain words “100 sites” in their name and these feature are leased for a two-year period.

parent

The number of a parent license key.

Supported key number formats:

PLSK.01234567.0001

PLSK.01234567

1234567 (leading zeros can be omitted)

Examples:

parent:(02637396, 02637397)

-parent: 1234567

owner

The license owner’s name or account ID.

Examples:

owner: 1234567

-owner:(tech, technologies)

reseller

The reseller account to which a license owner’s account is subordinate, either directly or indirectly.

Examples:

reseller: 1234567

This query finds licenses whose owner’s account is subordinate to the reseller with ID=1234567.

-reseller:(tech, technologies)

This query finds licenses whose owner’s account is not subordinate to reseller accounts that have “tech” or “technologies” in their names.

list The list parameter is used for finding licenses that have numbers matching the numbers from a user-specified list. The list of numbers is saved automatically with some ID. The list parameter takes this ID as a value. Learn more in Searching by a List of License Numbers.
guid

An attribute that is bound to a license, such as server’s hardware ID for PVC licenses, domain name for APS application licenses, and so on, depending on the type of product.

For example: guid:1111.dddd.2222.aaaa.2323.cccc

keyip

An IP address to which the license is bound by the user. This address is not necessarily the same as the actual IP address of the server where the corresponding product is installed. Such a parameter is useful for searching when the license number and activation code are not known.

Examples:

keyip:192.168.0.1

keyip:(192.168.0.10 - 192.168.0.20)

keyversion

This parameter is used to search for licenses that are applicable to a certain product version. The product version here is the version specified in the license properties.

Note: If you specify a major version (such as 9), all minor versions of this major version (such as 9.1, 9.5 and so on) will also be included in the search results.

Examples:

keyversion:7.5

keyversion:(7.5, 9)

keyversion:(6-10)

keyos

This parameter is used to search for licenses that are applicable to a certain type of operating system. This is the type of operating system specified in the license properties.

Possible values: unix, windows, macos, unified.

Examples:

keyos:unified

keyos:(unix, macos)

keyplatform

The type of platform specified in a license properties. Possible values: dedicated, container, vm.

Examples:

keyplatform:dedicated

keyplatform:(dedicated, vm)

keydomains

The limit on the number of domains (for licenses that support such a limit). Possible values: positive integer numbers and unlimited.

Examples:

keydomains:10

keydomains:(100, 300)

keydomains:(100-unlimited)

keysites

The limit on the number of websites (for licenses that support such a limit). Possible values: positive integer numbers and unlimited.

Examples:

keysites:unlimited

keysites:(1, 2, 5)

keysites:(1-10)

keypowerpack

This parameter is used to search for licenses with or without Plesk Power Pack. Possible values: yes, no.

For example: keypowerpack:yes

version

This parameter is used to search for licenses by the product version reported by the server where a license is installed (as opposed to the version specified in the license properties).

Note: If you specify a major version (such as 9), all minor versions of this major version (such as 9.1, 9.5, and so on) will also be included in the search results.

Examples:

version:7.5

version:(7.5, 9)

version:(6-10)

update

Use the update parameter to search for licenses installed in products that have specific updates to their product version. You should specify the update’s number. Only one value can be specified in one search query.

Example:

update:18

os

The operating system reported by the server where a license is installed (as opposed to the type of operating system specified in the license properties).

You can obtain all operating system names and versions reported to Partner Central and use them in your search. For this, open the report Licenses by OS (on the Reports tab) and view its column Operating System.

Examples:

os:("Ubuntu 12")

os:("Windows Server 2008")

ip

The IP address of the server where the product with the corresponding license is installed. This address can be either the IP address to which the license is bound by the user or the IP address reported by the server where the license is installed.

Examples:

ip:192.168.0.1

ip:(192.168.0.10 - 192.168.0.20)

conf

The name or a part of the name of the product configuration with which a license is associated.

For example: conf:"Default"

susexpiration

These parameters are used to filter licenses by SUS expiration date (susexpiration) or support expiration date (supexpiration).

You can specify the date in any of the following formats:

  • Little-endian (day, month, year): 31-12-2014, 31-Dec-2014
  • Big-endian (year, month, day): 2014-12-31, 2014-Dec-31
  • Middle-endian (month, day, year): Dec-31-2014

Examples:

  • susexpiration:"2014-07-01" - finds licenses with the SUS expiration date exactly on July 1, 2014.
  • susexpiration > "2014-07-01" - finds licenses with the SUS expiration date later than July 1, 2014.
  • susexpiration >= "2014-07-01" - finds licenses with the SUS expiration date either on July 1, 2014, or later.
  • susexpiration < "2014-07-01" - finds licenses with the SUS expiration date earlier than July 1, 2014.
  • susexpiration <= "2014-07-01" - finds licenses with the SUS expiration date either on July 1, 2014, or earlier.
  • susexpiration:("2014-07-01" - "2014-07-10") - finds licenses with the SUS expiration date between July 1 and July 10, 2014, inclusively.
  • susexpiration:("2014-07-01","2014-07-10") - finds licenses with the SUS expiration date either July 1, 2014 or July 10, 2014.
supexpiration  
creation

These parameters are used to filter licenses by date of their creation, termination, or expiration.

You can specify the date in any of the following formats:

  • Little-endian (day, month, year): 31-12-2014, 31-Dec-2014
  • Big-endian (year, month, day): 2014-12-31, 2014-Dec-31
  • Middle-endian (month, day, year): Dec-31-2014

Examples:

  • creation:"2014-07-01" - finds licenses created exactly on July 1, 2014.
  • creation > "2014-07-01" - finds licenses created after July 1, 2014.
  • creation > = "2014-07-01" - finds licenses created on July 1, 2014, or later.
  • creation < "2014-07-01" - finds licenses created before July 1, 2014.
  • creation <= "2014-07-01" - finds licenses created on July 1, 2014, or earlier.
  • creation:("2014-07-01" - "2014-07-10") - finds licenses created between July 1 and July 10, 2014, inclusively.
  • creation:("2014-07-01","2014-07-10") - finds licenses created on any of the dates: July 1 or July 10, 2014.
termination  
expiration  
fraud The only value available now is multiuse, which indicates that a license is detected as being used on multiple Plesk servers. There will be more values in the future.
keyiprestriction

The type of IP binding restriction behavior. Possible values: yes, no, "" (in case of empty value).

Examples:

  • keyiprestriction:yes - finds licenses that cannot be used with IP addresses other than the IP address they are bound to.
  • keyiprestriction:"" - finds licenses that are not bound to an IP address.
  • keyiprestriction:no - finds licenses that can be used with IP addresses other than the IP address they are bound to.
  • keyiprestriction:(no,"") - finds licenses that can be used with IP addresses other than the IP address they are bound to, or licenses that are not bound to an IP address.
sku

SKU is a code which relates to key types and is assigned to license keys on creation.

If the SKU contains one or more hyphen characters (“-“), use double quotation marks when you specify it.

Examples:

sku: "PLSK-HST-M"

sku: ("PLSK-HST-M","PLSK-ADM-M")