Documentation

Public API > PIN Code API.

Documentation Menu

PIN Code API

This page explains how to get a PIN code from your extracted from your Inventory.

Resources

URL
Description
Method
/inventory/{id}/pin
Returns a PIN code (string) from the computer's inventory by computer id
GET
/inventory/{computername}/pin
Returns a PIN code (string) from computer's inventory by computer name
GET

Headers

Name
Description
Type
apikey
Your apikey listed in your settings to retrieve the data
string

Filters

Filters can be supplied either as URL parameters or headers.
Name
Description
Type
pintype
Challenge = get a PIN2 based on PIN1 value. UninstallPIN = an uninstall PIN code. The default is challenge
string
pin1
Maximum number of resources to return. Default is 50 to preserve bandwidth, maximum is 10000. For queries with more than 10000 records, pagination is mandatory
string
  • Example: /inventory/win10test04/pin?pintype=challenge&pin1=123456
  • The return type is always a single string