Update Protection Key

Update protection key according to the action specified.

Method Type	URI
POST	v90/ws/target.ws

Sample Request

See Sample XML for Protection Key Web Services. The XML element names are self-explanatory. Some of the important elements are as follows:

NOTE The XML must comply with the schema provided for Protection key (see XSD for Protection Key Web Services).

XML Elements	Description	Type
action	(Required) The action to be taken on the Protection key. Action can be one of the following: >Checkin—Updates key information in the database. If key already exists, checks if it has pending updates or if it needs force introduce. Then it returns the key state (Products/Features/memory on the key). >Read—Takes the C2V as input and returns the decoded state of the C2V. >Readlatest—Takes the Key ID as input and returns the latest state of the product key from Sentinel LDK-EMS. See Sample Request for Read Latest Action. >Format—Cleans Products and memory data from the key in the C2V. Returns the V2C file. >ForceIntroduce—Overrides the key information in the database (by changing the update state to REMOVED) and inserting new information. >Enable—Changes the key state to enabled. >Disable—Changes the key state to disabled. >Fingerprint—Gets the fingerprint of the Protection key by C2V. >Locate—Locates the Protection key by C2V. >Clearclone—Creates a V2C file, which, when applied on the cloned machine, clears the key. >ClearTimeTamper—Re-enables blocked applications by changing the V-Clock time. You can specify the time using the tag <vclock_time></vclock_time>. If you do not specify a time, the server time will be set on the key. Before applying a V2C file to reset the V-Clock using the system clock, the system clock on the end user machine must be set to the current date and time. See Sample Request for ClearTimeTamper Action. >ConvertV2CToExe (Deprecated)—(Not supported for V2CP files) Converts the V2C corresponding to the C2V to an .exe file. The sample XML for this action is different from the sample mentioned above. See Sample XML for Protection Key Web Services. NOTE The response for this action is an XML string. The <Exe>...</Exe> tags in the XML contain the V2C text. >v7.3 and later—The V2C text is compressed, base-64-encoded. You decode and decompress this text using the GZIPInputStream Java class and saving it as an EXE file. See Update Protection Key. >For v7.2 and earlier—The V2C text is base-64-encoded (not compressed).	string
C2V	(Required) The C2V string.	string

XML Elements

Description

Type

action

(Required) The action to be taken on the Protection key. Action can be one of the following:

>Checkin—Updates key information in the database. If key already exists, checks if it has pending updates or if it needs force introduce. Then it returns the key state (Products/Features/memory on the key).

>Read—Takes the C2V as input and returns the decoded state of the C2V.

>Readlatest—Takes the Key ID as input and returns the latest state of the product key from Sentinel LDK-EMS. See Sample Request for Read Latest Action.

>Format—Cleans Products and memory data from the key in the C2V. Returns the V2C file.

>ForceIntroduce—Overrides the key information in the database (by changing the update state to REMOVED) and inserting new information.

>Enable—Changes the key state to enabled.

>Disable—Changes the key state to disabled.

>Fingerprint—Gets the fingerprint of the Protection key by C2V.

>Locate—Locates the Protection key by C2V.

>Clearclone—Creates a V2C file, which, when applied on the cloned machine, clears the key.

>ClearTimeTamper—Re-enables blocked applications by changing the V-Clock time.

You can specify the time using the tag <vclock_time></vclock_time>.

If you do not specify a time, the server time will be set on the key. Before applying a V2C file to reset the V-Clock using the system clock, the system clock on the end user machine must be set to the current date and time.

See Sample Request for ClearTimeTamper Action.

>ConvertV2CToExe (Deprecated)—(Not supported for V2CP files) Converts the V2C corresponding to the C2V to an .exe file. The sample XML for this action is different from the sample mentioned above. See Sample XML for Protection Key Web Services.

NOTE The response for this action is an XML string. The <Exe>...</Exe> tags in the XML contain the V2C text.

>v7.3 and later—The V2C text is compressed, base-64-encoded. You decode and decompress this text using the GZIPInputStream Java class and saving it as an EXE file. See Update Protection Key.

>For v7.2 and earlier—The V2C text is base-64-encoded (not compressed).

string

C2V

(Required) The C2V string.

string

Sample Response

Success

HTTP Status Code: 200

Response Body

>For SL:

<?xml version="1.0" encoding="UTF-8"?>
<ProtectionKey>
  <ProtectionKeyOutput>
    <C2V>
      <sentinel_ldk_info>
        <key>
          <id>103522632703563216</id>
          <type>SL-AdminMode</type>
          <update_counter>0</update_counter>
          <vendor>
            <id>37515</id>
            <name>DEMOMA - evaluation</name>
            <name>DEMOMA</name>
          </vendor>
          <configuration_info>
            <system_fingerprint>
              <raw_data>MXhJSc3Ra3UaiZmVuaZQkbk/1dvlDFEFbLQDQiNizXuNcFcVm7MfgIOIEuUzxCIi49UnAGFEJpf5EWIQ</raw_data>
            </system_fingerprint>
            <reference_fingerprint>
              <fingerprint_control_type>ISV Managed</fingerprint_control_type>
              <raw_data>MXhJSc3Ra3UaiZmVuaZQkbk/1dvlDFEFbLQDQiNizXuNcFcVm7MfgIOIEuUzxCIi49UnAGFEJpf5EWIQ</raw_data>
              <fingerprint_info>
                <criteria>
                  <name>cpu</name>
                  <value>2346217968</value>
                </criteria>
                <criteria>
                  <name>cpu</name>
                  <value>2346217968</value>
                </criteria>
                <criteria>
                  <name>mainboard</name>
                  <value>2308647382</value>
                </criteria>
                <criteria>
                  <name>mainboard_uid</name>
                  <value>3333349104</value>
                </criteria>
                <criteria>
                  <name>pci_storage_ide</name>
                  <value>3915100910</value>
                </criteria>
                <criteria>
                  <name>pci_storage_ide</name>
                  <value>4208916991</value>
                </criteria>
                <criteria>
                  <name>pci_network_ethernet</name>
                  <value>1547694809</value>
                </criteria>
                <criteria>
                  <name>pci_display_vga</name>
                  <value>6957148</value>
                </criteria>
                <criteria>
                  <name>pci_display_other</name>
                  <value>2892092458</value>
                </criteria>
                <criteria>
                  <name>pci_multimedia_audio</name>
                  <value>145814481</value>
                </criteria>
              </fingerprint_info>
            </reference_fingerprint>
            <fridge_version>1.8.21649</fridge_version>
            <vlib_version>2.0.1.21649</vlib_version>
          </configuration_info>
          <clone_detected>No</clone_detected>
          <rehost>
            <type>None</type>
            <counter>0</counter>
          </rehost>
          <product>
            <id>13</id>
            <name>Sl admin mode</name>
            <feature>
              <id>2</id>
              <name>6</name>
              <license_properties>
                <perpetual/>
                <concurrency>
                  <count>Unlimited</count>
                  <count_criteria>Per Station</count_criteria>
                  <network_access>No</network_access>
                  <detachable>No</detachable>
                </concurrency>
                <remote_desktop_access>No</remote_desktop_access>
                <virtual_machine_access>Yes</virtual_machine_access>
              </license_properties>
              <detach_license_count>0</detach_license_count>
              <locked>Yes</locked>
            </feature>
            <feature>
              <id>3</id>
              <name>
                <script>alert(hello)</script>
              </name>
              <license_properties>
                <perpetual/>
                <concurrency>
                  <count>Unlimited</count>
                  <count_criteria>Per Station</count_criteria>
                  <network_access>No</network_access>
                  <detachable>No</detachable>
                </concurrency>
                <remote_desktop_access>No</remote_desktop_access>
                <virtual_machine_access>Yes</virtual_machine_access>
              </license_properties>
              <detach_license_count>0</detach_license_count>
              <locked>Yes</locked>
            </feature>
          </product>
          <need_force>false</need_force>
        </key>
        <key>
          <type>SL-UserMode</type>
          <configuration_info>
            <system_fingerprint>
              <fingerprint_info>
                <criteria>
                  <name>cpu</name>
                  <value>2346217968</value>
                </criteria>
                <criteria>
                  <name>cpu</name>
                  <value>2346217968</value>
                </criteria>
                <criteria>
                  <name>mainboard</name>
                  <value>102122139</value>
                </criteria>
                <criteria>
                  <name>mainboard_uid</name>
                  <value>3333349104</value>
                </criteria>
                <criteria>
                  <name>hdd</name>
                  <value>235760321</value>
                </criteria>
                <criteria>
                  <name>optical_drive</name>
                  <value>4194054641</value>
                </criteria>
                <criteria>
                  <name>ethernet_uid</name>
                  <value>2630368524</value>
                </criteria>
                <criteria>
                  <name>pci_network_ethernet</name>
                  <value>1547694809</value>
                </criteria>
                <criteria>
                  <name>pci_display_vga</name>
                  <value>2892092458</value>
                </criteria>
                <criteria>
                  <name>pci_display_vga</name>
                  <value>6957148</value>
                </criteria>
              </fingerprint_info>
            </system_fingerprint>
          </configuration_info>
          <need_force>false</need_force>
        </key>
      </sentinel_ldk_info>
    </C2V>
  </ProtectionKeyOutput>
</ProtectionKey>

>For HL:

<?xml version="1.0" encoding="UTF-8"?>
<ProtectionKey>
  <ProtectionKeyOutput>
    <C2V>
      <sentinel_ldk_info>
        <key>
          <id>388830185</id>
          <type>HL-Max-Micro</type>
          <update_counter>178</update_counter>
          <vendor>
            <id>37515</id>
            <name/>
            <name>DEMOMA</name>
          </vendor>
          <configuration_info>
            <firmware_revision>3.25</firmware_revision>
            <real_time_clock_present>No</real_time_clock_present>
            <manufacturing_date>2011-8-2</manufacturing_date>
            <flash_memory_size>No Flash</flash_memory_size>
          </configuration_info>
          <product>
            <id>2</id>
            <name>base</name>
            <feature>
              <id>1</id>
              <name>11</name>
              <license_properties>
                <perpetual/>
                <remote_desktop_access>No</remote_desktop_access>
              </license_properties>
            </feature>
          </product>
          <product>
            <id>3</id>
            <name>555</name>
            <feature>
              <id>1</id>
              <name>11</name>
              <license_properties>
                <execution_count>5</execution_count>
                <used_execution_count>0</used_execution_count>
                <remote_desktop_access>Yes</remote_desktop_access>
              </license_properties>
            </feature>
          </product>
          <need_force>false</need_force>
        </key>
      </sentinel_ldk_info>
    </C2V>
  </ProtectionKeyOutput>
</ProtectionKey>

Failure

HTTP Status Code: 404

Response Body: Product does not exist.