API docs by Redocly

Key Administrator Partner API 3.0 (3.0)

Download OpenAPI specification:

Key Administrator Partner API 3.0 provides a RESTful interface for managing license keys.

Key Features:

  • Create, retrieve, modify, and terminate license keys
  • Suspend and resume license keys
  • Upgrade and downgrade license key items
  • Bind license keys to IP addresses
  • Generate SSO tokens for seamless authentication

Authentication: All API requests require HTTP Basic authentication using your Partner API credentials.

Request/Response Format: The API uses JSON for request and response bodies. All requests should include Content-Type: application/json header.

Distributed Tracing: For observability, include traceparent header following the W3C Trace Context standard.

provisioningPayload: Some products require additional provisioning parameters passed via provisioningPayload field. See individual endpoint documentation for details.

Available Nova Cloud Constants (Partner API 3.0):

Constant Plan
WPC-NOVA-PLSK-FREE-1M Free
WPC-NOVA-PLSK-START-1M Start
WPC-NOVA-PLSK-BUILD-1M Build
WPC-NOVA-PLSK-GROW-1M Grow
WPC-NOVA-PLSK-SCALE-1M Scale

Resources:

License Keys

Operations for managing license keys (create, retrieve, modify, terminate)

Create a license key

Creates a new license key.

Note: License keys cannot be created for reseller accounts. To create a license key for a client account owned by a reseller account, that client account's ID must be passed via the ownerId field.

provisioningPayload section is used to pass additional product-specific provisioning parameters:

  • domain (optional) — The domain name for the product (max 255 characters)
  • zoneId (required) — The zone identifier for provisioning. Available zones are provided individually per partner.
  • locale (required) — Locale in BCP 47 format (e.g., "en-US", "tr-TR", "de-DE")
Authorizations:
basicAuth
query Parameters
return-key-state
boolean
Default: false

Defines whether to return the License Key Structure of a created key in the response (false by default).

Request Body schema: application/json
required
ownerId
string

ID of the client account that will own the key. If omitted, the API account's client is used.

object or null

Identifiers of the parent key to attach to.

object or null

Activation info (UID) for immediate activation.

ipAddressBinding
string or null

IP address to bind the key to.

nickname
string

Short description (nickname) of the key.

productConfigurationId
integer or null

Product configuration ID to assign.

required
Array of objects (KeyItem)

License key items (constants). At least one item is required.

autoRenew
boolean or null

Whether the key should be auto-renewed.

restrictIPBinding
boolean or null

Whether to restrict IP binding changes.

storeURL
string or null

Store URL associated with the key.

Array of objects or null (ProvisioningPayload)

Product-specific provisioning parameters passed as name/value pairs.

Input parameters (request):

  • domain (optional) — The domain name for the product (max 255 characters)
  • zoneId (required) — The zone identifier for provisioning. Available zones are provided individually per partner.
  • locale (required) — Locale in BCP 47 format (e.g., "en-US", "tr-TR", "de-DE")

Output parameters (response):

  • domain — The domain name configured for the product
  • zoneId — The zone identifier used for provisioning
  • locale — The configured locale
  • cname — The CNAME record for the package
  • packageId — The unique package identifier (UUID)

Responses

Request samples

Content type
application/json
Example
{
  • "items": [
    ],
  • "provisioningPayload": [
    ]
}

Response samples

Content type
application/json
Example
{
  • "ownerId": "93097396",
  • "keyIdentifiers": {
    },
  • "parentKeyIdentifiers": null,
  • "activationInfo": null,
  • "ipAddressBinding": null,
  • "nickname": "",
  • "productConfigurationId": null,
  • "items": [
    ],
  • "creationDate": "2026-01-30T15:29:52.825Z",
  • "lastModificationDate": "2026-01-30T15:29:52.842Z",
  • "updateDate": "2026-02-28T00:00:00.000Z",
  • "expirationDate": "2026-03-10T00:00:00.000Z",
  • "susExpirationDate": null,
  • "susStatus": null,
  • "supportExpirationDate": null,
  • "supportStatus": null,
  • "status": "ACTIVE",
  • "terminated": false,
  • "suspended": false,
  • "ownerSuspended": false,
  • "autoRenew": true,
  • "restrictIPBinding": false,
  • "frauds": [ ],
  • "lastReportingDate": null,
  • "lastReportingIp": null,
  • "lastReportingOs": null,
  • "childKeyIdentifiers": [ ],
  • "overridingKeyIdentifiers": null,
  • "storeURL": null,
  • "provisioningPayload": [
    ]
}

Retrieve a license key structure

Retrieves the full License Key Structure for the specified key.

Compatibility note: Some key configurations cannot be presented as a set of Partner API 3.0 constants. This can happen when you manage a key not only by Partner API 3.0, but also via UI or Partner API 1.0. The structure of such keys can contain unmatched items. An item contains a feature name or base license name.

Unmatched items cannot be modified (upgraded or downgraded) through the Partner API 3.0 and should be passed without changes when calling the Modify Key command.

Response includes provisioningPayload with product-specific parameters if the key was created with provisioning data.

Authorizations:
basicAuth
path Parameters
keyNumberOrProductKey
required
string
Example: WPC.12389802.0000

KA key number or activation code.

Responses

Response samples

Content type
application/json
Example
{
  • "ownerId": "93097396",
  • "keyIdentifiers": {
    },
  • "parentKeyIdentifiers": null,
  • "activationInfo": null,
  • "ipAddressBinding": null,
  • "nickname": "",
  • "productConfigurationId": null,
  • "items": [
    ],
  • "creationDate": "2026-01-30T15:29:52.825Z",
  • "lastModificationDate": "2026-01-30T15:29:52.842Z",
  • "updateDate": "2026-02-28T00:00:00.000Z",
  • "expirationDate": "2026-03-10T00:00:00.000Z",
  • "susExpirationDate": null,
  • "susStatus": null,
  • "supportExpirationDate": null,
  • "supportStatus": null,
  • "status": "ACTIVE",
  • "terminated": false,
  • "suspended": false,
  • "ownerSuspended": false,
  • "autoRenew": true,
  • "restrictIPBinding": false,
  • "frauds": [ ],
  • "lastReportingDate": null,
  • "lastReportingIp": null,
  • "lastReportingOs": null,
  • "childKeyIdentifiers": [ ],
  • "overridingKeyIdentifiers": null,
  • "storeURL": null,
  • "provisioningPayload": [
    ]
}

Modify a license key

Modifies the specified license key. Operations are inferred from which fields are present in the request body.

Supported operations:

  • Move a license key to another owner
  • Suspend or resume a license key
  • Upgrade a license key
  • Activate or re-activate a license key
  • Bind/unbind a license key to/from an IP address
  • Assign a product configuration to a license key
  • Attach/detach to/from a parent key
  • Update a license key short description (nickname)
  • Update the autoRenew flag

Note: Certain operations cannot be performed together within the same HTTP request to avoid ambiguity.

Order of execution (highest priority first):

  1. Move/suspend/resume
  2. Upgrade
  3. Activate/re-activate
  4. Bind/unbind IP address
  5. Assign product configuration
  6. Attach/detach parent key
  7. Rebuild key items
  8. Update nickname
  9. Update autoRenew flag
Authorizations:
basicAuth
path Parameters
keyNumberOrProductKey
required
string
Example: WPC.12389802.0000

KA key number or activation code.

query Parameters
return-key-state
boolean
Default: false

Determines whether to return License Key Structure of the modified key in the response (false by default).

Request Body schema: application/json
required
ownerId
string

Move key to another owner by specifying a new owner ID.

object or null

Attach/detach parent key.

object or null

Activate or re-activate the key.

ipAddressBinding
string or null

Bind/unbind the key to/from an IP address.

nickname
string

Update the short description (nickname) of the key.

productConfigurationId
integer or null

Assign a product configuration.

Array of objects (KeyItem)

Upgrade or downgrade key items.

suspended
boolean or null

Suspend (true) or resume (false) the key.

autoRenew
boolean or null

Update the auto-renew flag.

restrictIPBinding
boolean or null

Update the restrict IP binding flag.

storeURL
string or null

Update the store URL.

Responses

Request samples

Content type
application/json
Example
{
  • "items": [
    ]
}

Response samples

Content type
application/json
{
  • "ownerId": "93097396",
  • "keyIdentifiers": {
    },
  • "status": "ACTIVE",
  • "terminated": false,
  • "suspended": false
}

Terminate a license key

Terminates the specified license key.

Note: Any additional licenses attached to a terminated license must be terminated separately.

Authorizations:
basicAuth
path Parameters
keyNumberOrProductKey
required
string
Example: WPC.12389802.0000

KA key number or activation code.

query Parameters
return-key-state
boolean
Default: false

Defines whether to return License Key Structure of the terminated key in response (false by default).

Responses

Response samples

Content type
application/json
{
  • "ownerId": "93097396",
  • "keyIdentifiers": {
    },
  • "status": "TERMINATED",
  • "terminated": true
}