Error Responses
The following is a list of all error responses returned by the License API.
All errors have an HTTP status of 400 or higher and the response body is a JSON object in the following format:
{
status: number,
code: string,
message: string
}JSON Schema
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"status": { "type": "number" },
"code": { "type": "string" },
"message": { "type": "string" }
},
"required": [
"status",
"code",
"message"
],
"additionalProperties": false
}Code
Status
Notes
404
not_found
Requested API path doesn't exist
400
validation_error
Caused by request data not conforming to the validation schema. The message of the error response contains details on what failed
400
missing_headers
A required header is missing
400
missing_parameters
A required parameter in the query or body of the request is missing
400
missing_content
An offline activation/deactivation request received an empty request
400
invalid_json
Caused by general invalid json in POST requests
400
active_license_required
A /versions or /installation_file request is called without an active license provided in the parameters
400
api_key_product_not_allowed
An activation is being attempted using an API key which does not have permissions to activate the requested product
400
archived_product
An activation is being attempted on a product which is archived
400
authorization_invalid_headers
Provided Authorization header is malformed
400
authorization_missing_params
Provided Authorization header has missing data
400
blacklisted
Activation is being attempted using a blacklisted device
400
borrow_until_not_valid
/floating/borrow is being called with an invalid borrowed_until date
400
change_password_not_allowed
/change_password is being called but is not allowed
400
customer_account_id_mismatch
400
customer_account_not_found
When creating an order, the provided customer_account_id does not match an existing customer
400
customer_does_not_exist
/customer_license_users is being called but the provided customer does not exist
400
customer_not_found
/customer_license_users is being called with authorization values which do not grant permissions to view data for the given customer
400
device_not_found
A license deactivation or an endpoint which changes license values is being called using an inactive license device
400
disabled_product
A license activation is being attempted on a product which is disabled
400
email_missing
A request to generate a trial license for a user-based license is being attempted with no email provided
400
feature_not_enough_consumptions
Adding a feature consumption is being attempted but the consumption limit has already been reached
400
feature_not_floating
/floating/feature_release is being called on a feature which is not a floating cloud feature
400
floating_feature_device_not_in_use
/floating/feature_release is being called on a feature which has no associated used device
400
floating_not_available
A check, borrow or release is being called on a floating cloud license which has no available slots left
400
hardware_key_required
An action is being attempted which requires a licensespring-hardware-key header
400
hmac_required
An API-key-based Authorization header was sent but is missing a hmac value
400
invalid_api_key
An invalid API key is being used
400
invalid_hardware_id
An action requiring a hardware ID parameter received an empty hardware ID
400
invalid_license_feature_code
A license feature action is being attempted on a feature which cannot be found
400
invalid_product_auth_method
/customer_license_users is being called on a product which is not a user-based product
400
invalid_value
A provided parameter does not contain a valid value. The message of the error will contain more information on the parameter and acceptable values
400
key_product_based_does_not_allow_users
An order is being created for a key-based license, but a list of users was provided
400
license_activated_max_times
A new license activation is being attempted, but the license has already been activated the maximum number of times allowed
400
license_borrow_not_allowed
A license borrowing is being attempted on a license which does not allow borrowing
400
license_device_exists
400
license_expired
A license activation or borrowing is being attempted on an expired license
400
license_hwid_not_found
/device_licenses is being called, but the provided device has no associated licenses
400
license_not_active
An action is being attempted on a license which is not active
400
license_not_consumption
A consumption action is being attempted on a license which is not a consumption-type license
400
license_not_enabled
An action is being attempted on a license which is not enabled
400
license_not_enough_consumptions
Adding a license consumption is being attempted but the consumption limit has already been reached
400
license_not_found
An action is being attempted on a license which cannot be found
400
license_start_date_error
A license activation is being attempted but is not allowed by the license's start_date
400
license_transferred_max_times
A license transfer is being attempted, but the maximum number of allowed transfers has already been reached
400
license_user_activated_max_times
A new license activation is being attempted, but the license user has already activated this license the maximum number of times allowed
400
license_user_not_found
An action is being attempted for a user-based license, but the provided user is not associated to the license
400
license_users_error
An order is being created but the number of provided users exceeds the max_license_users value set on the license
400
missing_hardware_key_certificate
A request requiring a licensespring-hardware-key was sent but the device specified has no assigned device certificate
400
negative_consumptions_not_allowed
A consumption request with a negative consumption value was sent, but negative consumptions are not allowed on this license
400
oauth_product_not_allowed
An OAuth-authorized request is being attempted using OAuth credentials which do not have access to the requested resource
400
oauth_required
A request is being attempted using API Key credentials, but OAuth is enforced as the only allowed authorization mechanism
400
oauth_token_expired
A request is being attempted using an expired OAuth token
400
oauth_token_malformed
A request is being attempted using a malformed OAuth token
400
offline_floating_cloud_not_supported
An offline activation is being attempted on a floating cloud license which does not allow offline activation
400
product_not_bundle
A bundle action is being attempted but the specified product is not a bundle
400
quantity_too_large
A request for generating license keys was sent to the /license webhook, but the requested amount of keys to generate exceeds the maximum allowed quantity
400
read_only_api_key
A non-read action is being attempted using a read-only API Key
400
revoked_api_key
An action is being attempted using an API Key which has been revoked
400
trial_expired
An activation is being attempted on an expired trial license
400
trial_not_allowed
A trial license is being requested but the product does not allow trial licenses
400
unknown_policy_code
A license policy was specified in the request but no such policy was found
400
unknown_product_code
A product code was specified in the request but no such product was found
400
unsupported_product_feature
A feature consumption is being attempted on a feature which is not a consumption feature
400
user_based_product_does_not_allow_license_key
A license in the order request contains a license key but the product is not a key-based product
400
user_not_assigned_to_product
A /user_licenses request has been sent but the provided user is not assigned to any license
400
version_not_found
An /installation_file request has been sent but no file version has been found that matches the given parameters
400
vm_not_allowed
An activation is being attempted which was sent from a Virtual Machine but the licenses disallows VM activations
401
authentication_failure
Authentication for the request has failed
401
hardware_key_signature_mismatch
The hardware key value sent in the licensespring-hardware-key is invalid
401
invalid_client_credentials
OAuth authentication failed
401
offline_signature_mismatch
An offline activation or deactivation is being attempted but the provided signature value is invalid
401
signature_mismatch
An API-key request is being sent but the signature in the header is invalid
409
license_key_exists
An order request has been sent but failed due to a license_key collision
409
order_id_exists
A non-appending order request has been sent but the provided order id already exists
500
internal_error
An unexpected server error has occured
500
adding_manager_error
An error has occured while attempting to assign a license manager
500
mail_sending_error
An error has occured while attempting to send a notification for a consumption or assigning a license user to a license order
500
notification_sending_error
An error has occured while attempting to send a notification for a license activation, trial key, order creation
Was this helpful?