website logo
⌘K
Getting Started
Introduction
Basic Concepts
Opening an Account
Creating & Configuring Products
Integrating SDK and Configuring License Fulfillment
Activate a Key-Based License
Vendor Platform
Issuing New Licenses
License Detail View
Order Detail View
Customer Detail View
Metadata
Analytics
Settings
Product Configuration
Product Features
Product Custom Fields
Product Versioning
License Policies
Product Bundles
License Entitlements
License Types
Activations & Device Transfers
Features
Custom Fields
License Start Date
License Note
Maintenance Period
Trial Licenses
Floating Licenses
License Activation Types
Portals
End-User Portal
Offline Portal
Air-Gapped Portal
License API
License API Authorization
License Activation/Deactivation
License Check
Consumption
Floating
Trial Key
Product Details
Device Variables
Changing Password
Management API
Making API Requests
Management API Authorization
Customer
Product
Order
License
Device
Analytics
SDKs
Tutorials
.NET/C# SDK
.NET/C# Management SDK
C++ SDK
Java SDK
Python SDK
Go SDK
Delphi SDK
Swift/Objective-C SDK
Android SDK
Unity SDK
Errors and Response Codes
Floating Server
API Reference
Deployment
Configuration
Floating Server UI
Securing the Server
Whitelabeling
FAQ
Floating Server Changelog
Integrations
Salesforce
FastSpring
Stripe
Shopify
Common Scenarios
Single Sign On (SSO)
Glossary
General
SDK Glossary
Vendor Platform
Product Configuration Glossary
License Configuration
Postman Collections
Frequently Asked Questions
Changelog
License API changelog
Platform changelog
Docs powered by
Archbee
License API
License Activation/Deactivatio...

License Deactivation

6min
Deactivation of a product license for a specific device identified by its hardware ID
POST
Params
Header Parameters
Date
required
String
eq. Thu, 17 Nov 2022 20:51:35 GMT
Authorization
required
String
See signing of the License API calls article.
Body Parameters
hardware_id
required
String
Unique hardware ID generated for some device
product
required
String
Product short code
license_key
optional
String
Required if product is key_based. Attach the license key (eq. 1111-2222-3333-4444)
username
optional
String
Required if product is user based. Attach the assigned license user email (eq. user@example.com)
password
optional
String
Required if product is user based. Attach the assigned license user password (eq. somepassword)
id_token
optional
String
Required if using SSO. Attach the id_token received from the SSO if Implicit grant authorization method is being used.
code
optional
String
Required if using SSO. Attach the code received from the SSO if Authorization code grant method is being used.
customer_account_code
optional
String
Required if using SSO. Attach the customer_account_code to which SSO provider is configured.
is_vm
optional
Boolean
Set as true if using virtual machine.
vm_info
optional
String
Optional virtual machine informations.
os_ver
optional
String
Version of the operating system.
hostname
optional
String
Device hostname
os_hostname
optional
String
Hostname of the OS ( check this before publishing! )
ip
optional
String
IP address
ip_local
optional
String
Local IP address ( check this before publishing! )
app_ver
optional
String
Version of the product application used with this license.
sdk_ver
optional
String
Version of the SDK used.
mac_address
optional
String
Device MAC address
Curl
Node.js
JS
Python
Ruby
|
var myHeaders = new Headers();
myHeaders.append("Accept", "application/json");
myHeaders.append("Date", "string");
myHeaders.append("Authorization", "string");

var raw = "{\"hardware_id\":\"String\",\"product\":\"string\",\"license_key\":\"string\",\"username\":\"string\",\"password\":\"string\",\"id_token\":\"string\",\"code\":\"string\",\"customer_account_code\":\"string\",\"is_vm\":\"Boolean\",\"vm_info\":\"string\",\"os_ver\":\"string\",\"hostname\":\"string\",\"os_hostname\":\"string\",\"ip\":\"string\",\"ip_local\":\"string\",\"app_ver\":\"string\",\"sdk_ver\":\"string\",\"mac_address\":\"string\"}";

var requestOptions = {
   method: 'POST',
   headers: myHeaders,
   body: raw,
   redirect: 'follow'
};

fetch("/api/v4/deactivate_license", requestOptions)
   .then(response => response.text())
   .then(result => console.log(result))
   .catch(error => console.log('error', error));
RESPONSES
200
400
|
{
    "unknown_product": "Provided product was not found",
    "license_not_found": "License with the provided license user not found",
    "license_not_enabled": "The license is not enabled",
    "vm_not_allowed": "Virtual machine not allowed",
    "offline_floating_cloud_not_supported": " Floating cloud licenses cannot be activated offline.",
    "license_start_date_error": "This license cannot be activated before start date: {date}",
    "blacklisted": "This device is blacklisted",
    "license_activated_max_times": "This license  has already been activated the maximum number of times",
    "license_user_activated_max_times": "License user has activated this license max times",
    "license_expired": "License validity period has expired.",
    "license_transferred_max_times": "This license has already been transferred the maximum number of times",
    "license_device_exists": "A device matching this hardware_id is already created on the license"
}


User-Based License Activation

Curl
|
curl --location --request POST 'https://api.licensespring.com/api/v4/deactivate_license' \
--header 'Date: Mon, 10 May 2021 13:14:18 GMT' \
--header 'Authorization: algorithm="hmac-sha256",headers="date",signature="{generated_signature}",apikey="{your_api_key}"' \
--header 'Content-Type: application/json' \
--data-raw '{
    "username": "test@example.com",
    "password": "some_password123",
    "hardware_id": "some-unique-id",
    "product": "XY"
}'


List of exceptions

unknown_product (400): Provided product was not found
license_not_found (400): License with the provided license user not found
license_not_active (400): The license is not active
device_not_found (400): An active device matching the hardware_id not found
missing_headers (400): Some headers are missing



Updated 22 Sep 2023
Did this page help you?
PREVIOUS
License Activation
NEXT
License Activation Offline
Docs powered by
Archbee
/api/v4/deactivate_license
TABLE OF CONTENTS
POST
/api/v4/deactivate_license
User-Based License Activation
List of exceptions
Docs powered by
Archbee