Version : 14.0
BasePath : /
Logs the user into the linked device account
isSystem required |
||
orgId required |
||
token required |
Logs the user into the linked device
Returns a list of all organizations
filter optional |
||
filtering optional |
||
offset optional |
||
paging optional |
||
properties optional |
||
sorting optional |
< Organization > array |
Fetches result for last authentication attempt for SAML mobile logins
credentials required |
Logs out the currently logged in user
redirectTo optional |
Changes the organization the user is logged into
organizationId required |
Changes the organization the user is logged into
id required |
Refreshes the current security context
kaceGO optional |
|||
organizationName optional |
Returns supported authentication types (right now, local and/or SAML)
AuthTypes optional |
Accepts 2factor token from accounts that require one. Call immediately after login.
verificationData required |
currentCode optional |
||
skipConfiguration optional |
organizationName optional |
|
password optional |
|
userName optional |
authStorageExpiration optional |
|
key optional |
|
value optional |
expires optional |
|
key optional |
accountId optional |
|
actionCode optional |
|
affectedIds optional |
|
affectedResourceType optional |
|
id optional |
|
message optional |
|
organizationId optional |
|
severityCode optional |
|
timestamp optional |
id optional |
|
isDeleted optional |
|
isEnabled optional |
|
isSystem optional |
|
locationAttrName optional |
|
name optional |
|
syncLocations optional |
|
timeZone optional |
|
version optional |
type optional |
Version : 14.0
BasePath : /api/asset
Returns the archived asset associated with the id
id required |
||
shaping optional |
||
sorting optional |
||
use_count optional |
||
use_count_only optional |
||
use_pretty_print optional |
filtering optional |
||
offset optional |
||
paging optional |
||
shaping optional |
||
sorting optional |
||
use_count optional |
||
use_count_only optional |
||
use_pretty_print optional |
AssetStatus optional |
< asset_status > array |
Returns the asset status associated with the id
id required |
||
shaping optional |
||
sorting optional |
||
use_count optional |
||
use_count_only optional |
||
use_pretty_print optional |
AssetStatus optional |
< asset_status > array |
assetData required |
Assets optional |
filtering optional |
||
offset optional |
||
paging optional |
||
shaping optional |
||
sorting optional |
||
use_count optional |
||
use_count_only optional |
||
use_pretty_print optional |
Assets optional |
Returns a list of all asset types
AssetTypes optional |
< asset_type > array |
assetID required |
||
fieldName required |
id required |
||
assetData required |
Assets optional |
Returns the asset associated with the id
id required |
||
shaping optional |
||
sorting optional |
||
use_count optional |
||
use_count_only optional |
||
use_pretty_print optional |
Assets optional |
id required |
||
assetData required |
Assets optional |
id required |
id required |
Returns all barcodes associated with the specified asset.
id required |
Barcodes optional |
id required |
barcodeData required |
Barcodes optional |
< barcode_update > array |
filtering optional |
||
offset optional |
||
paging optional |
||
shaping optional |
||
sorting optional |
||
use_count optional |
||
use_count_only optional |
||
use_pretty_print optional |
Returns the barcode associated with the id
id required |
||
shaping optional |
||
sorting optional |
||
use_count optional |
||
use_count_only optional |
||
use_pretty_print optional |
id required |
||
barcodeData required |
Barcodes optional |
< barcode_update > array |
id required |
Returns a list of all license assets
appliesToSoftware optional |
||||
filtering optional |
||||
offset optional |
||||
paging optional |
||||
shaping optional |
||||
sorting optional |
||||
use_count optional |
||||
use_count_only optional |
||||
use_pretty_print optional |
Licenses optional |
asset_id optional |
|
id optional |
|
name optional |
archive optional |
|
archive_reason optional |
|
asset_class_id optional |
|
asset_data_id optional |
|
asset_status_id optional |
|
asset_type_id optional |
|
id optional |
|
location_id optional |
|
mapped_id optional |
|
name optional |
|
owner_id optional |
AssetTypeID optional |
|
ColumnName optional |
|
DefaultAssetStatusID optional |
|
ForSubtype optional |
|
Name optional |
|
Required optional |
|
Type optional |
description optional |
|
id optional |
|
is_system optional |
|
name optional |
AssetTypeID optional |
|
AssetTypeName optional |
|
CanDelete optional |
|
DefaultAssetStatusID optional |
|
SubTypes optional |
|
properties optional |
< asset_property > array |
barcode_data required |
|
barcode_format required |
|
barcode_name required |
|
first_scanned_geolocation read-only |
|
first_scanned_method read-only |
|
first_scanned_user read-only |
|
id optional |
|
last_scanned_geolocation read-only |
|
last_scanned_method read-only |
|
last_scanned_user read-only |
asset_id required |
Only valid when creating new barcode. Required, used to associate with a specific asset |
|
barcode_data required |
||
barcode_format required |
||
barcode_name required |
||
id optional |
||
scanned_geolocation required |
||
scanned_method required |
category optional |
|
checksum optional |
|
comments optional |
|
contact optional |
|
custom_field_value0 optional |
|
custom_field_value1 optional |
|
custom_field_value2 optional |
|
custom_field_value3 optional |
|
custom_field_value4 optional |
|
custom_field_value5 optional |
|
display_name optional |
|
display_version optional |
|
dont_replicate optional |
|
file_name optional |
|
file_size optional |
|
help_link optional |
|
help_telephone optional |
|
id optional |
|
install_date optional |
|
installed_count optional |
|
inventory_rule optional |
|
is_manual optional |
|
is_patch optional |
|
notes optional |
|
publisher optional |
|
quiet_uninstall_string optional |
|
readme optional |
|
rule_data_type optional |
|
rule_flag optional |
|
threat optional |
|
uninstall_string optional |
|
urlinfo_about optional |
|
version optional |
This section provides examples for adding attachments to assets using the KACE SMA API.
Each example uses the following assumptions:
• |
The Device asset type has two custom fields of type attachment, and they are tagged as field_10002 and field_10003 in the JSON. |
Version : 14.0
BasePath : /api/inventory
Retrieves the data for any matching machines.
filterOptions optional |
||||
filtering optional |
||||
offset optional |
||||
paging optional |
||||
shaping optional |
||||
sorting optional |
||||
use_count optional |
||||
use_count_only optional |
||||
use_pretty_print optional |
Machines optional |
Retrieves the data for the specific ID given. All query parameters are available.
id required |
||
shaping optional |
||
sorting optional |
||
use_count optional |
||
use_count_only optional |
||
use_pretty_print optional |
Retrieves the custom inventory for the specific machine ID.
id required |
CustomInventory optional |
< machine_custom_inventory > array |
id required |
Retrieves custom inventory fields associated with a machine
machineID required |
CustomInventory optional |
< machine_custom_inventory > array |
Retrieves uploaded files associated with a machine
machineID required |
UploadedFiles optional |
< machine_uploaded_file > array |
Retrieves uploaded file associated with a machine
fileID required |
||
machineID required |
Retrieves the data for any matching agentless nodes.
filtering optional |
||
offset optional |
||
paging optional |
||
shaping optional |
||
sorting optional |
||
use_count optional |
||
use_count_only optional |
||
use_pretty_print optional |
Retrieves the data for the specific ID given. All query parameters are available.
id required |
||
shaping optional |
||
sorting optional |
||
use_count optional |
||
use_count_only optional |
||
use_pretty_print optional |
filtering optional |
||
offset optional |
||
paging optional |
||
shaping optional |
||
sorting optional |
||
use_count optional |
||
use_count_only optional |
||
use_pretty_print optional |
Retrieves the data for the specific ID given. All query parameters are available.
id required |
||
shaping optional |
||
sorting optional |
||
use_count optional |
||
use_count_only optional |
||
use_pretty_print optional |
filtering optional |
||
offset optional |
||
paging optional |
||
shaping optional |
||
sorting optional |
||
use_count optional |
||
use_count_only optional |
||
use_pretty_print optional |
Retrieves the data for the specific ID given. All query parameters are available.
id required |
||
shaping optional |
||
sorting optional |
||
use_count optional |
||
use_count_only optional |
||
use_pretty_print optional |
filtering optional |
||
offset optional |
||
paging optional |
||
shaping optional |
||
sorting optional |
||
use_count optional |
||
use_count_only optional |
||
use_pretty_print optional |
Retrieves the data for the specific ID given. All query parameters are available.
id required |
||
shaping optional |
||
sorting optional |
||
use_count optional |
||
use_count_only optional |
||
use_pretty_print optional |
filtering optional |
||
offset optional |
||
paging optional |
||
shaping optional |
||
sorting optional |
||
use_count optional |
||
use_count_only optional |
||
use_pretty_print optional |
Retrieves the data for the specific ID given. All query parameters are available.
id required |
||
shaping optional |
||
sorting optional |
||
use_count optional |
||
use_count_only optional |
||
use_pretty_print optional |
filtering optional |
||
offset optional |
||
paging optional |
||
shaping optional |
||
sorting optional |
||
use_count optional |
||
use_count_only optional |
||
use_pretty_print optional |
Retrieves the data for the specific ID given. All query parameters are available.
id required |
||
shaping optional |
||
sorting optional |
||
use_count optional |
||
use_count_only optional |
||
use_pretty_print optional |
Edition optional |
|
Id optional |
|
Is_Mobile optional |
|
License_Type optional |
|
Major_Version optional |
|
Name optional |
|
Product_Name optional |
|
Publisher optional |
|
Sam_Type optional |
|
Software_Category optional |
|
Software_Category_Id optional |
|
Software_Platform optional |
|
Software_Platform_Id optional |
|
Support_Url optional |
Alt_Checksum optional |
|
Alt_Location optional |
|
Create_Location optional |
|
Create_Shortcut optional |
|
Credential_Id_Alt_Location optional |
|
Credential_Id_Location optional |
|
Enabled optional |
|
Hour_Begin optional |
|
Hour_End optional |
|
Id optional |
|
Location optional |
|
No_Uncompress optional |
|
Notes optional |
|
Persistent optional |
|
Postinstall_Message optional |
|
Preinstall_Message optional |
|
Remove_Files optional |
|
Replace_Existing optional |
|
Shortcut_Name optional |
|
Software_Id optional |
|
Target_All_Machines optional |
|
Type optional |
Bulletin optional |
|
Bundled_By optional |
|
Bundles optional |
|
Classification optional |
|
Cve optional |
|
Description optional |
|
Id optional |
|
Impact_Install optional |
|
Impact_Uninstall optional |
|
Info_Url optional |
|
Is_Superceded optional |
|
Is_Supported_Install optional |
|
Is_Supported_Uninstall optional |
|
Patch_Guid optional |
|
Patch_Identifier optional |
|
Patch_Type optional |
|
Publisher optional |
|
Reboot_Install optional |
|
Reboot_Uninstall optional |
|
Request_User_Input_Install optional |
|
Request_User_Input_Uninstall optional |
|
Required_By optional |
|
Requires optional |
|
Severity optional |
|
Superceded_By optional |
|
Supercedes optional |
|
Title optional |
App_Ctrl_Enabled optional |
|
Id optional |
|
Kace_Alt_Location optional |
|
Kace_Alt_Location_Password_Enc optional |
|
Kace_Alt_Location_User optional |
|
Meter_Enabled optional |
|
Name optional |
|
Notes optional |
|
Scope_User_Role_Id optional |
|
Type optional |
|
Usage_All optional |
|
Usage_Catalog optional |
|
Usage_Dell optional |
|
Usage_Label optional |
|
Usage_Machine optional |
|
Usage_Node optional |
|
Usage_Patch optional |
|
Usage_Process optional |
|
Usage_Software optional |
|
Usage_User optional |
Conversion_Status optional |
|
Device_Id optional |
|
Drive_Letter optional |
|
Encryption_Method optional |
|
Encryption_Percentage optional |
|
Hardware_Encryption_Status optional |
|
Id optional |
|
Identification_Field optional |
|
Is_System_Volume optional |
|
Key_Protectors optional |
|
Lock_Status optional |
|
Persistent_Volume_Id optional |
|
Protection_Status optional |
|
Version optional |
|
Wiping_Percentage optional |
|
Wiping_Status optional |
Annotated_Location optional |
|
Annotated_User optional |
|
Boot_Mode optional |
|
Device_Id optional |
|
Firmware_Version optional |
|
Id optional |
|
Mac_Address optional |
|
Machine_Chromeos_Details_Id optional |
|
Meid optional |
|
Model optional |
|
Notes optional |
|
Order_Number optional |
|
Org_Unit_Path optional |
|
Os_Version optional |
|
Platform_Version optional |
|
Serial_Number optional |
|
Status optional |
|
Will_Auto_Renew optional |
Id optional |
|
Machine_Id optional |
Agent_Version optional |
|
Id optional |
|
Mcid optional |
|
Protection_Status optional |
|
Server_Hostname optional |
Device_Id optional |
|
Id optional |
|
Protection_Reason optional |
|
Protection_Status optional |
Id optional |
|
Name optional |
Id optional |
|
Is_Drive_Encryption_Enabled optional |
|
Is_Drive_Protected optional |
|
Protection_Reason optional |
Authorized_Users optional |
|
Conversion_Percentage optional |
|
Conversion_Status optional |
|
Device_Id optional |
|
Encryption_Status optional |
|
Encryption_Type optional |
|
Has_Institutional_Recovery_Key optional |
|
Has_Personal_Recovery_Key optional |
|
Id optional |
|
Is_Enabled optional |
|
Version optional |
Configuration_Mode optional |
|
Control_Mode optional |
|
Fw_Version optional |
|
Id optional |
|
Is_Amt_Configured optional |
|
Is_Amt_Enabled_In_Bios optional |
|
Is_Amt_Supported optional |
|
Is_Mei_Enabled optional |
|
Mei_Version optional |
|
Sku optional |
|
State optional |
|
Version optional |
Counrty optional |
|
Country_Code optional |
|
Id optional |
|
Locality optional |
|
Machine_Location_Id optional |
|
Postal_Code optional |
|
Region optional |
|
Street_Address optional |
Activation_Lock_Allowed optional |
|
Activation_Lock_Bypass_Code optional |
|
Activation_Lock_Enabled optional |
|
Battery_Level optional |
|
Carrier optional |
|
Current_Carrier_Network optional |
|
Data_Roaming_Enabled optional |
|
Dep_Assigned_By optional |
|
Dep_Profile optional |
|
Dep_Profile_Status optional |
|
Device_Type optional |
|
Do_Not_Disturb_Enabled optional |
|
Eas_Device_Id optional |
|
Iccid optional |
|
Icloud_Enabled optional |
|
Id optional |
|
Imei optional |
|
Is_Compliant optional |
|
Is_Dep_Configured optional |
|
Is_Dep_Managed optional |
|
Is_Encrypted optional |
|
Is_Enrolled optional |
|
Is_Itunes_Account_Active optional |
|
Is_Lost optional |
|
Is_Rooted optional |
|
Is_Supervised optional |
|
Locator_Service_Enabled optional |
|
Machine_Mobile_Id optional |
|
Meid optional |
|
Modem_Firmware optional |
|
Phone_Number optional |
|
Udid optional |
|
Voice_Roaming_Enabled optional |
|
Wifi_Bytes_Recv optional |
|
Wifi_Bytes_Sent optional |
|
Wwan_Bytes_Recv optional |
|
Wwan_Bytes_Sent optional |
Dhcp_Enabled optional |
|
Dnsdoman optional |
|
Dnshostname optional |
|
Id optional |
|
Ip optional |
|
Ipv6_Config optional |
|
Mac optional |
|
Netmask optional |
|
Nic optional |
|
Nic_Id optional |
Checksum optional |
|
Error optional |
|
File_Name optional |
|
File_Size optional |
|
Machine_Id optional |
|
Ordinal optional |
|
Path optional |
|
Type optional |
|
Type_Id optional |
|
Zip_Package optional |
Full_Walk optional |
|
Machine_Id optional |
|
Machine_Snmp_Data_Id optional |
Id optional |
|
Is_Activated optional |
|
Is_Enabled optional |
|
Is_Owned optional |
|
Manufacturer_Id optional |
|
Manufacturer_Id_Text optional |
|
Manufacturer_Version optional |
|
Manufacturer_Version_Info optional |
|
Physical_Presence_Version_Info optional |
|
Specification_Version optional |
Attempt_Count optional |
|
Machine_Id optional |
|
Mi_Id optional |
|
Run_Now optional |
Aw_Id optional |
|
Aw_Status optional |
|
Chromeos_Id optional |
|
Chromeos_Status optional |
|
Cli_Status optional |
|
Dmm_Id optional |
|
Dmm_Status optional |
|
G_Mobile_Id optional |
|
G_Mobile_Status optional |
|
Host_Name optional |
|
Id optional |
|
Ip optional |
|
Kmm_Id optional |
|
Kmm_Status optional |
|
Ldap_Status optional |
|
Mac optional |
|
Machine_Id optional |
|
Nmap_Status optional |
|
Os_Type optional |
|
Ping_Status optional |
|
Real_Name optional |
|
Relay_Machine_Id optional |
|
Scan_Settings_Id optional |
|
Snmp_Contact optional |
|
Snmp_Status optional |
|
Snmp_Sysdescr optional |
|
Snmp_Uptime optional |
|
Snmp_Version optional |
|
Snmp_Walk_Data optional |
|
Socket_Status optional |
|
Vmware_Status optional |
|
Vmware_Type optional |
|
Winrm_Status optional |
Admin_Status optional |
|
Descr optional |
|
Id optional |
|
Ifindex optional |
|
In_Discards optional |
|
In_Errors optional |
|
In_Nucastpkts optional |
|
In_Octets optional |
|
In_Ucastpkts optional |
|
In_Unknownprotos optional |
|
Last_Change optional |
|
Mtu optional |
|
Oper_Status optional |
|
Out_Discards optional |
|
Out_Errors optional |
|
Out_Nucastpkts optional |
|
Out_Octets optional |
|
Out_Ucastpkts optional |
|
Phys_Address optional |
|
Specific optional |
|
Speed optional |
|
Type optional |
Contact optional |
|
Description optional |
|
Full_Walk optional |
|
Id optional |
|
Location optional |
|
Name optional |
|
Object_Id optional |
|
Uptime optional |
Can_Interact_With_Desktop optional |
|
Category optional |
|
Command_Args optional |
|
Command_Exe optional |
|
Company_Name optional |
|
Description optional |
|
Display_Name optional |
|
File_Description optional |
|
File_Name optional |
|
File_Version optional |
|
Id optional |
|
Logon_As_User optional |
|
Name optional |
|
Notes optional |
|
Product_Name optional |
|
Product_Version optional |
|
Startup_Type optional |
|
Status optional |
|
Threat optional |
Arch optional |
|
Build optional |
|
Common_Name optional |
|
Description optional |
|
Family optional |
|
Id optional |
|
Major_Version optional |
|
Managed optional |
|
Minor2_Version optional |
|
Minor_Version optional |
|
Name optional |
|
Os_Family_Id optional |
|
Os_Product_Id optional |
|
Patch_Package_Code optional |
|
Sp optional |
Deploy_Attempt_Count optional |
|
Deploy_Error_Code optional |
|
Deploy_Status optional |
|
Detect_Error_Code optional |
|
Detect_Rdesc optional |
|
Detect_Status optional |
|
Is_Error optional |
|
Machine_Id optional |
|
Max_Deploy_Attempt optional |
|
Max_Rollback_Attempt optional |
|
Patch_Applicable optional |
|
Patch_Id optional |
|
Patch_Installed optional |
|
Product_Installed optional |
|
Rollback_Attempt_Count optional |
|
Rollback_Error_Code optional |
|
Rollback_Status optional |
Id optional |
|
Machine_Id optional |
|
Patch_Schedule_Id optional |
|
Patch_Schedule_Run_Id optional |
|
Status optional |
Category optional |
|
Command_Args optional |
|
Command_Exe optional |
|
Company_Name optional |
|
File_Description optional |
|
File_Name optional |
|
File_Version optional |
|
Id optional |
|
Name optional |
|
Notes optional |
|
Product_Name optional |
|
Product_Version optional |
|
Threat optional |
Id optional |
|
Last_Report optional |
|
Machine_Id optional |
Id optional |
|
Is_Mobile optional |
|
Latest_Entry optional |
|
Launches optional |
|
Machine_Id optional |
|
Process_Id optional |
|
Seconds_Used optional |
|
Titled_Application_Id optional |
|
User_Data optional |
|
Version optional |
Category optional |
|
Checksum optional |
|
Comments optional |
|
Contact optional |
|
Custom_Field_Value0 optional |
|
Custom_Field_Value1 optional |
|
Custom_Field_Value2 optional |
|
Custom_Field_Value3 optional |
|
Custom_Field_Value4 optional |
|
Custom_Field_Value5 optional |
|
Display_Name optional |
|
Display_Version optional |
|
Dont_Replicate optional |
|
File_Name optional |
|
File_Size optional |
|
Help_Link optional |
|
Help_Telephone optional |
|
Id optional |
|
Install_Date optional |
|
Inventory_Rule optional |
|
Is_Manual optional |
|
Is_Patch optional |
|
Notes optional |
|
Publisher optional |
|
Quiet_Uninstall_String optional |
|
Readme optional |
|
Rule_Data_Type optional |
|
Rule_Flag optional |
|
Threat optional |
|
Uninstall_String optional |
|
Urlinfo_About optional |
|
Version optional |
Category optional |
|
Command_Args optional |
|
Command_Exe optional |
|
Company_Name optional |
|
File_Description optional |
|
File_Name optional |
|
File_Version optional |
|
Id optional |
|
Name optional |
|
Notes optional |
|
Product_Name optional |
|
Product_Version optional |
|
Threat optional |
name optional |
|
type optional |
|
value optional |
id optional |
|
name optional |
|
size optional |
© 2024 Quest Software Inc. ALL RIGHTS RESERVED. Feedback 利用規約 プライバシー Cookie Preference Center