Chat now with support
Chat mit Support

KACE Systems Management Appliance 10.0 Common Documents - API Reference Guide

API Reference

API Reference

KACE SMA API

Overview

Version information

Version : 10.0

URI scheme

BasePath : /

Consumes

application/json

Produces

application/json

Paths

GET /ams/shared/api/accounts/

Description

Returns a list of all accounts.

Responses

HTTP Code
Schema

200

< Account > array

POST /ams/shared/api/accounts/search

Description

Allows for searching of accounts

Responses

HTTP Code
Schema

200

< Account > array

GET /ams/shared/api/accounts/{accountId}

Description

Returns the selected account.

Parameters

Type
Name
Schema

Path

accountId required

integer

Query

registry required

string

Responses

HTTP Code
Schema

200

Account

GET /ams/shared/api/accounts/{accountId}/organizationAccounts

Description

Returns a list of organization accounts associated with the selected account.

Parameters

Type
Name
Schema

Path

accountId required

integer

Query

filter optional

string

Query

properties optional

string

Responses

HTTP Code
Schema

200

< OrganizationAccount > array

Add or if find by key and account then Update

Description

Create a new registry key for the selected account.

Parameters

Type
Name
Schema

Path

accountId required

integer

Query

registry required

string

Responses

HTTP Code
Schema

200

AccountRegistry

GET /ams/shared/api/accounts/{accountId}/registry

Description

Returns a list of registry keys for the selected account

Parameters

Type
Name
Schema

Path

accountId required

integer

Query

categories required

string

Query

keys required

string

Responses

HTTP Code
Schema

200

< AccountRegistry > array

DELETE /ams/shared/api/accounts/{accountId}/registry/{category}/{registryKey}

Description

Removes a registry key by category and account

Parameters

Type
Name
Schema

Path

accountId required

integer

Path

category required

string

Path

registryKey required

string

Responses

HTTP Code
Schema

200

No Content

GET /ams/shared/api/accounts/{managerId}/managedAccounts

Description

Returns a list of accounts managed by selected account

Parameters

Type
Name
Schema

Path

managerId required

integer

Responses

HTTP Code
Schema

200

< Account > array

POST /ams/shared/api/kkmp/login

Description

Logs the user into the linked device account

Parameters

Type
Name
Schema

Query

isSystem required

boolean

Query

orgId required

integer

Query

token required

string

Responses

HTTP Code
Schema

200

No Content

POST /ams/shared/api/kkmp/login_user

Description

Logs the user into the linked device

Responses

HTTP Code
Schema

200

Response

POST /ams/shared/api/locations

Description

Returns all locations

Parameters

Type
Name
Schema

Body

location required

Location

Responses

HTTP Code
Schema

200

Location

GET /ams/shared/api/locations/{locationId}

Description

Returns the selected location

Parameters

Type
Name
Schema

Path

locationId required

integer

Query

fields optional

string

Responses

HTTP Code
Schema

200

Location

PUT /ams/shared/api/locations/{locationId}

Description

Updates the selected location.

Parameters

Type
Name
Schema

Path

locationId required

integer

Body

locationDTO required

Location

Responses

HTTP Code
Schema

200

Location

DELETE /ams/shared/api/locations/{locationId}

Description

Removes the selected location

Parameters

Type
Name
Schema

Path

locationId required

integer

Responses

HTTP Code
Schema

200

No Content

GET /ams/shared/api/organizationAccounts

Description

Return all organization accounts

Parameters

Type
Name
Schema

Query

filtering optional

string

Query

offset optional

string

Query

paging optional

string

Query

shaping optional

string

Query

sorting optional

string

Responses

HTTP Code
Schema

200

PagingResponse

DELETE /ams/shared/api/organizationAccounts

Description

Deletes the selected organization accounts.

Parameters

Type
Name
Schema

Query

ids required

integer

Query

moveEmployeesTo required

integer

Responses

HTTP Code
Schema

200

No Content

POST /ams/shared/api/organizationAccounts/

Description

Creates a new organization account.

Parameters

Type
Name
Schema

Body

orgAccountDTO required

OrganizationAccount

Responses

HTTP Code
Schema

200

OrganizationAccount

POST /ams/shared/api/organizationAccounts/disable

Description

Disables the selected organization accounts.

Parameters

Type
Name
Schema

Query

ids required

integer

Responses

HTTP Code
Schema

200

No Content

POST /ams/shared/api/organizationAccounts/enable

Description

Enables the selected organization accounts.

Parameters

Type
Name
Schema

Query

ids required

integer

Responses

HTTP Code
Schema

200

No Content

POST /ams/shared/api/organizationAccounts/search

Description

Searches the organization accounts by the search criteria

Parameters

Type
Name
Schema

Body

SearchDTO required

OrgAccSearch

Responses

HTTP Code
Schema

200

< OrganizationAccount > array

DELETE /ams/shared/api/organizationAccounts/{orgAccId}

Description

Deletes a single organization account by id

Parameters

Type
Name
Schema

Path

orgAccId required

integer

Query

moveEmployeesTo required

integer

Responses

HTTP Code
Schema

200

No Content

GET /ams/shared/api/organizationAccounts/{orgAccountId}

Description

Gets the selected organization account.

Parameters

Type
Name
Schema

Path

orgAccountId required

integer

Query

properties required

string

Responses

HTTP Code
Schema

200

OrganizationAccount

PUT /ams/shared/api/organizationAccounts/{orgAccountId}

Description

Updates an existing organization account

Parameters

Type
Name
Schema

Path

orgAccountId required

integer

Body

organizationAccountDTO required

OrganizationAccount

Responses

HTTP Code
Schema

200

OrganizationAccount

PUT /ams/shared/api/organizationAccounts/{orgAccountId}/addEmployees

Description

Adds employees to the associated organization account

Parameters

Type
Name
Schema

Path

orgAccountId required

integer

Body

idListDTO required

IdList

Responses

HTTP Code
Schema

200

No Content

POST /ams/shared/api/organizationAccounts/{orgAccountId}/hasRole

Description

Checks to see if the organization account has a specific role.

Parameters

Type
Name
Schema

Path

orgAccountId required

integer

Query

includeInherited optional

integer

Query

productId optional

integer

Query

roleName optional

string

Responses

HTTP Code
Schema

200

boolean

Add or if find by key and account then Update

Description

Add a new registry key to an organization account

Parameters

Type
Name
Schema

Path

orgAccountId required

integer

Body

registry optional

OrgAccountRegistry

Responses

HTTP Code
Schema

200

OrgAccountRegistry

GET /ams/shared/api/organizationAccounts/{orgAccountId}/registry

Description

Returns a list of registry keys associated with the selected organization account

Parameters

Type
Name
Schema

Path

orgAccountId required

integer

Query

categories optional

string

Query

keys optional

string

Responses

HTTP Code
Schema

200

OrgAccountRegistry

DELETE /ams/shared/api/organizationAccounts/{orgAccountId}/registry/{category}/{registryKey}

Description

Remove a registry key from an organization account by category

Parameters

Type
Name
Schema

Path

category required

string

Path

orgAccountId required

integer

Path

registryKey required

string

Responses

HTTP Code
Schema

200

No Content

POST /ams/shared/api/organizations

Description

Creates a new organization

Parameters

Type
Name
Schema

Body

organizationDTO required

Organization

Responses

HTTP Code
Schema

200

Organization

GET /ams/shared/api/organizations

Description

Returns a list of all organizations

Parameters

Type
Name
Schema

Query

filter optional

string

Query

filtering optional

string

Query

offset optional

string

Query

paging optional

string

Query

properties optional

string

Query

sorting optional

string

Responses

HTTP Code
Schema

200

< Organization > array

DELETE /ams/shared/api/organizations

Description

Removes the selected organizations

Parameters

Type
Name
Schema

Query

ids required

integer

Responses

HTTP Code
Schema

200

No Content

POST /ams/shared/api/organizations/disable

Description

Disables the selected organizations

Parameters

Type
Name
Schema

Query

ids required

integer

Responses

HTTP Code
Schema

200

No Content

POST /ams/shared/api/organizations/enable

Description

Enables the selected organizations

Parameters

Type
Name
Schema

Query

ids required

integer

Responses

HTTP Code
Schema

200

No Content

GET /ams/shared/api/organizations/list

Description

Returns a list of all organizations

Parameters

Type
Name
Schema

Query

filtering optional

string

Query

getTZ optional

string

Query

offset optional

string

Query

paging optional

string

Query

shaping optional

string

Query

sorting optional

string

Responses

HTTP Code
Schema

200

PagingResponse

GET /ams/shared/api/organizations/{organizationId}

Description

Returns a specific organization

Parameters

Type
Name
Schema

Path

organizationId required

integer

Responses

HTTP Code
Schema

200

Organization

PUT /ams/shared/api/organizations/{organizationId}

Description

Updates an existing organization

Parameters

Type
Name
Schema

Path

organizationId required

integer

Body

organizationDTO required

Organization

Responses

HTTP Code
Schema

200

Organization

GET /ams/shared/api/organizations/{organizationId}/account/{accountId}

Description

Returns a specific account within an organization

Parameters

Type
Name
Schema

Path

accountId required

integer

Path

organizationId required

integer

Responses

HTTP Code
Schema

200

OrganizationAccount

GET /ams/shared/api/organizations/{organizationId}/history

Description

Returns the history for the organization

Parameters

Type
Name
Schema

Path

organizationId required

integer

Query

accounts optional

string

Query

entities optional

string

Query

events optional

string

Responses

HTTP Code
Schema

200

History

GET /ams/shared/api/organizations/{organizationId}/locations

Description

Returns the locations associated with an organization

Parameters

Type
Name
Description
Schema

Path

organizationId required

integer

Query

fields optional

Comma seperated list of fields

string

Responses

HTTP Code
Schema

200

< Location > array

GET /ams/shared/api/organizations/{organizationId}/organizationAccounts

Description

Returns a list of organization accounts for an organization

Parameters

Type
Name
Schema

Path

organizationId required

integer

Query

filter optional

string

Query

properties optional

string

Responses

HTTP Code
Schema

200

< OrganizationAccount > array

GET /ams/shared/api/organizations/{organizationId}/roles

Description

Returns all roles associated with an organization

Parameters

Type
Name
Schema

Path

organizationId required

integer

Query

productId optional

integer

Responses

HTTP Code
Schema

200

< OrganizationRole > array

POST /ams/shared/api/products

Description

Creates a new product

Parameters

Type
Name
Schema

Body

productDTO required

Product

Responses

HTTP Code
Schema

200

Product

GET /ams/shared/api/products

Description

Returns a list of all products

Parameters

Type
Name
Schema

Query

filtering optional

string

Query

offset optional

string

Query

paging optional

string

Query

sorting optional

string

Responses

HTTP Code
Schema

200

< Product > array

DELETE /ams/shared/api/products

Description

Remove the selected products

Parameters

Type
Name
Schema

Query

ids required

integer

Responses

HTTP Code
Schema

200

No Content

POST /ams/shared/api/products/update

Description

Updates the specific product

Responses

HTTP Code
Schema

200

No Content

GET /ams/shared/api/products/{productId}

Description

Returns a specific product

Parameters

Type
Name
Schema

Path

productId required

integer

Responses

HTTP Code
Schema

200

Product

GET /ams/shared/api/products/{productId}/roles

Description

Returns the roles associated with a product

Parameters

Type
Name
Schema

Path

productId required

integer

Query

organizationId required

integer

Responses

HTTP Code
Schema

200

< Role > array

POST /ams/shared/api/roles

Description

Creates a new role

Parameters

Type
Name
Schema

Query

organizationId required

integer

Query

productId required

integer

Body

roleDTO required

Role

Responses

HTTP Code
Schema

200

Role

GET /ams/shared/api/roles

Description

Returns a list of roles

Parameters

Type
Name
Schema

Query

name required

string

Query

organizationId required

integer

Query

productId required

integer

Responses

HTTP Code
Schema

200

Role

DELETE /ams/shared/api/roles

Description

Removes the selected roles

Parameters

Type
Name
Schema

Query

ids required

integer

Responses

HTTP Code
Schema

200

No Content

GET /ams/shared/api/roles/{roleId}

Description

Returns the selected role

Parameters

Type
Name
Schema

Path

roleId required

integer

Responses

HTTP Code
Schema

200

ole

PUT /ams/shared/api/roles/{roleId}

Description

Updates the selected role

Parameters

Type
Name
Schema

Path

roleId required

integer

Body

roleDTO required

Role

Responses

HTTP Code
Schema

200

ole

GET /ams/shared/api/roles/{roleId}/organizationAccounts

Description

Returns a list of the organization accounts associated with the selected role

Parameters

Type
Name
Schema

Path

roleId required

integer

Responses

HTTP Code
Schema

200

< OrganizationAccount > array

POST /ams/shared/api/security/login

Description

Logs the user in

Parameters

Type
Name
Schema

Body

credentials required

ApiCredentials

Responses

HTTP Code
Schema

200

No Content

GET /ams/shared/api/security/logout

Description

Logs out the currently logged in user

Parameters

Type
Name
Schema

Query

redirectTo optional

string

Responses

HTTP Code
Schema

200

Response

POST /ams/shared/api/security/organization/switch

Description

Changes the organization the user is logged into

Parameters

Type
Name
Schema

Query

organizationId required

integer

Responses

HTTP Code
Schema

200

No Content

POST /ams/shared/api/security/organization/{id}/switchto

Description

Changes the organization the user is logged into

Parameters

Type
Name
Schema

Path

id required

integer

Responses

HTTP Code
Schema

200

No Content

GET /ams/shared/api/security/refreshcontext

Description

Refreshes the current security context

Responses

HTTP Code
Schema

200

No Content

POST /ams/shared/api/security/verifyPW

Description

Verifies the users password

Parameters

Type
Name
Schema

Query

orgID required

integer

Query

pw required

string

Query

userName required

string

Responses

HTTP Code
Schema

200

boolean

POST /ams/shared/api/security/verify_2factor

Description

Accepts 2factor token from accounts that require one

Parameters

Type
Name
Schema

Body

verificationData required

verificationData

verificationData

Name
Schema

currentCode optional

integer

Responses

HTTP Code
Schema

200

No Content

POST /ams/shared/api/{roleId}/addOrganizationAccounts

Description

Add an organization account to the selected role

Parameters

Type
Name
Schema

Path

roleId required

integer

Query

ids required

integer

Responses

HTTP Code
Schema

200

No Content

POST /ams/shared/api/{roleId}/removeOrganizationAccounts

Description

Remove the organization account from the selected role

Parameters

Type
Name
Schema

Path

roleId required

integer

Query

ids required

integer

Responses

HTTP Code
Schema

200

No Content

Definitions

Account

Name
Schema

ADDomain optional

string

IMAddress optional

string

creationMode optional

integer

dateTimeFormat optional

string

distinguishedName optional

string

fullName optional

string

id optional

integer

isDeleted optional

boolean

jobTitle optional

string

language optional

string

login optional

string

mobilePhone optional

string

numberFormat optional

string

overrideLocationSettings optional

boolean

password optional

string

passwordChangedAt optional

string(date-time)

principalName optional

string

timeZone optional

string

userType optional

integer

version optional

string(date-time)

workPhone optional

string

AccountEmail

Name
Schema

account optional

Account

email optional

string

sorting optional

integer

AccountRegistry

Name
Schema

account optional

Account

categoryName optional

string

id optional

integer

key optional

string

value optional

string

AuthStorage

Name
Schema

authStorageExpiration optional

AuthStorageExpiration

key optional

string

value optional

string

AuthStorageExpiration

Name
Schema

expires optional

integer

key optional

string

History

Name
Schema

accountId optional

integer

action optional

integer

creationDt optional

string(date-time)

entityId optional

integer

entityName optional

string

id optional

integer

parentEntityId optional

integer

parentEntityName optional

string

HistoryDetail

Name
Schema

history optional

History

historyId optional

integer

id optional

integer

propertyName optional

string

HistoryDetailDatetime

Name
Schema

history optional

History

historyId optional

integer

id optional

integer

newValue optional

string(date-time)

oldValue optional

string(date-time)

propertyName optional

string

HistoryDetailReference

Name
Schema

history optional

History

historyId optional

integer

id optional

integer

newValue optional

integer

oldValue optional

integer

propertyName optional

string

refName optional

string

HistoryDetailString

Name
Schema

history optional

History

historyId optional

integer

id optional

integer

newValue optional

string

oldValue optional

string

propertyName optional

string

LinkedAccountToken

Name
Schema

created optional

string(date-time)

id optional

integer

organizationAccount optional

OrganizationAccount

token optional

string

Location

Name
Schema

address optional

string

appData optional

string

description optional

string

id optional

integer

isDeleted optional

boolean

level optional

integer

locale optional

string

name optional

string

organization optional

Organization

parent optional

Location

path optional

string

phoneNumber optional

string

primaryContact optional

OrganizationAccount

webSite optional

string

Notification

Name
Schema

accountId optional

integer

actionCode optional

integer

affectedIds optional

string

affectedResourceType optional

integer

id optional

integer

message optional

string

organizationId optional

integer

severityCode optional

integer

timestamp optional

string(date-time)

OrgAccountRegistry

Name
Schema

categoryName optional

string

id optional

integer

key optional

string

orgAccount optional

OrganizationAccount

value optional

string

Organization

Name
Schema

id optional

integer

isDeleted optional

boolean

isEnabled optional

boolean

isSystem optional

boolean

locationAttrName optional

string

name optional

string

primaryLocation optional

Location

syncLocations optional

boolean

timeZone optional

string

version optional

string(date-time)

OrganizationAccount

Name
Schema

account optional

Account

created optional

string(date-time)

id optional

integer

isEnabled optional

boolean

level optional

integer

location optional

Location

manager optional

OrganizationAccount

path optional

string

version optional

string(date-time)

Product

Name
Schema

allowMultipleRoles optional

boolean

baseApiUrl optional

string

baseNavigationUrl optional

string

baseViewUrl optional

string

callbackUrl optional

string

configuration optional

string

description optional

string

fullName optional

string

id optional

string

shortName optional

string

Role

Name
Schema

created optional

string(date-time)

description optional

string

id optional

integer

isDefaultAdminRole optional

boolean

isDefaultApplianceAdminRole optional

boolean

isDefaultUserRole optional

boolean

name optional

string

organization optional

Organization

product optional

Product

productRoleId optional

string

version optional

string(date-time)

SystemSetting

Name
Schema

key optional

string

value optional

string

Asset API Reference

Asset API Reference

KACE SMA Asset API Reference

Overview

Version information

Version : 10.0

URI scheme

BasePath : /api/asset

Consumes

application/json

Produces

application/json

Paths

GET /api/asset/archived_devices/{id}

Description

Returns the archived asset associated with the id

Parameters

Type
Name
Schema

Path

id required

integer

Query

shaping optional

string

Query

sorting optional

string

Query

use_count optional

string

Query

use_count_only optional

string

Query

use_pretty_print optional

boolean

Responses

HTTP Code
Schema

200

< string > array

GET /api/asset/asset_status

Description

Returns all barcodes

Parameters

Type
Name
Schema

Query

filtering optional

string

Query

offset optional

string

Query

paging optional

string

Query

shaping optional

string

Query

sorting optional

string

Query

use_count optional

string

Query

use_count_only optional

string

Query

use_pretty_print optional

boolean

Responses

HTTP Code
Schema

200

< string > array

GET /api/asset/asset_status/{id}

Description

Returns the barcode associated with the id

Parameters

Type
Name
Schema

Path

id required

integer

Query

shaping optional

string

Query

sorting optional

string

Query

use_count optional

string

Query

use_count_only optional

string

Query

use_pretty_print optional

boolean

Responses

HTTP Code
Schema

200

< string > array

POST /api/asset/assets

Description

Creates a new asset

Parameters

Type
Name
Schema

Body

assetData required

< string > array

Responses

HTTP Code
Schema

200

integer

GET /api/asset/assets/

Description

Returns a list of all assets

Parameters

Type
Name
Schema

Query

filtering optional

string

Query

offset optional

string

Query

paging optional

string

Query

shaping optional

string

Query

sorting optional

string

Query

use_count optional

string

Query

use_count_only optional

string

Query

use_pretty_print optional

boolean

Responses

HTTP Code
Schema

200

< object > array

GET /api/asset/assets/types

Description

Returns a list of all asset types

Responses

HTTP Code
Schema

200

< object > array

GET /api/asset/assets/version

Description

Returns the version associated with this API endpoint.

Responses

HTTP Code
Schema

200

string

GET /api/asset/assets/{id}

Description

Returns the asset associated with the id

Parameters

Type
Name
Schema

Path

id required

integer

Query

shaping optional

string

Query

sorting optional

string

Query

use_count optional

string

Query

use_count_only optional

string

Query

use_pretty_print optional

boolean

Responses

HTTP Code
Schema

200

< string > array

PUT /api/asset/assets/{id}

Description

Updates an asset

Parameters

Type
Name
Schema

Path

id required

integer

Body

assetData required

< string > array

Responses

HTTP Code
Schema

200

string

DELETE /api/asset/assets/{id}

Description

Removes an asset

Parameters

Type
Name
Schema

Path

id required

integer

Responses

HTTP Code
Schema

200

string

POST /api/asset/assets/{id}/archive/

Parameters

Type
Name
Schema

Path

id required

integer

Responses

HTTP Code
Schema

200

string

GET /api/asset/assets/{id}/barcodes

Description

Returns all barcodes associated with the specified asset.

Parameters

Type
Name
Schema

Path

id required

integer

Responses

HTTP Code
Schema

200

< object > array

POST /api/asset/assets/{id}/cancel_archive/

Parameters

Type
Name
Schema

Path

id required

integer

Responses

HTTP Code
Schema

200

string

POST /api/asset/barcodes

Description

Creates a new barcode

Parameters

Type
Name
Schema

Body

barcodeData required

string

Responses

HTTP Code
Schema

200

string

GET /api/asset/barcodes

Description

Returns all barcodes

Parameters

Type
Name
Schema

Query

filtering optional

string

Query

offset optional

string

Query

paging optional

string

Query

shaping optional

string

Query

sorting optional

string

Query

use_count optional

string

Query

use_count_only optional

string

Query

use_pretty_print optional

boolean

Responses

HTTP Code
Schema

200

< string > array

GET /api/asset/barcodes/version

Description

Returns the version associated with this API endpoint.

Responses

HTTP Code
Schema

200

string

GET /api/asset/barcodes/{id}

Description

Returns the barcode associated with the id

Parameters

Type
Name
Schema

Path

id required

integer

Query

shaping optional

string

Query

sorting optional

string

Query

use_count optional

string

Query

use_count_only optional

string

Query

use_pretty_print optional

boolean

Responses

HTTP Code
Schema

200

< string > array

PUT /api/asset/barcodes/{id}

Description

Updates the selected barcode

Parameters

Type
Name
Schema

Path

id required

integer

Body

barcodeData required

string

Responses

HTTP Code
Schema

200

string

DELETE /api/asset/barcodes/{id}

Description

Removes the selected barcode

Parameters

Type
Name
Schema

Path

id required

integer

Responses

HTTP Code
Schema

200

string

GET api/asset/archived_devices/version

Description

Returns the version associated with this API endpoint.

Responses

HTTP Code
Schema

200

string

Definitions

archive_asset_device

Name
Schema

asset_id optional

integer

id optional

integer

name optional

string

asset

Name
Schema

archive optional

string

archive_reason optional

string

asset_class_id optional

integer

asset_data_id optional

integer

asset_status_id optional

integer

asset_type_id optional

integer

id optional

integer

location_id optional

integer

mapped_id optional

integer

name optional

string

owner_id optional

integer

asset_status

Name
Schema

description optional

string

id optional

integer

is_system optional

integer

name optional

string

barcode

Name
Description
Schema

asset_id optional

Only valid when creating new barcode. Required, used to associate with a specific asset

integer

barcode_data optional

string

barcode_format optional

string

barcode_name optional

string

first_scanned_geolocation optional

string

first_scanned_method optional

string

first_scanned_user optional

string

id optional

integer

last_scanned_geolocation optional

string

last_scanned_method optional

string

last_scanned_user optional

string

machine

Name
Schema

asset_tag optional

string

bios_description optional

string

bios_identification_code optional

string

bios_manufacturer optional

string

bios_name optional

string

bios_serial_number optional

string

bios_version optional

string

cdrom_devices optional

string

chassis_type optional

string

client_version optional

string

cpu_name optional

string

cs_domain optional

string

cs_manufacturer optional

string

cs_model optional

string

csp_id_number optional

string

custom_field_value0 optional

string

custom_field_value1 optional

string

custom_field_value2 optional

string

custom_field_value3 optional

string

custom_field_value4 optional

string

custom_field_value5 optional

string

domain optional

string

dot_net_versions optional

string

edge_version optional

string

force_inventory optional

integer

id optional

integer

ie_version optional

string

ip optional

string

ipv6 optional

string

kpatch_language_id optional

string

kuid optional

string

last_reboot optional

string

last_shutdown optional

string

last_user optional

string

mac optional

string

manual_entry optional

integer

manufacturer_product_number optional

string

monitor optional

string

motherboard_primary_bus optional

string

motherboard_secondary_bus optional

string

name optional

string

netmask optional

string

notes optional

string

os_arch optional

string

os_build optional

string

os_family optional

string

os_id optional

integer

os_installed_date optional

string

os_major optional

string

os_minor optional

string

os_minor2 optional

string

os_name optional

string

os_number optional

string

os_release optional

string

os_version optional

string

ownership optional

string

pagefile_max_size optional

string

pagefile_size optional

string

physical_cores optional

integer

physical_processors optional

integer

prefix_len optional

integer

printers optional

string

processors optional

string

ram_max optional

string

registry_max_size optional

string

registry_size optional

string

sda_deployment_name optional

string

sda_deployment_type optional

string

sda_deployment_url optional

string

sda_installation_id optional

string

sda_name optional

string

sda_url optional

string

service_pack optional

string

sound_devices optional

string

sys_arch optional

string

system_description optional

string

system_directory optional

string

tz_agent optional

string

uptime optional

string

user optional

string

user_domain optional

string

user_fullname optional

string

user_logged optional

string

user_name optional

string

video_controllers optional

string

virtual optional

string

wmi_status optional

string

software

Name
Schema

category optional

string

checksum optional

string

comments optional

string

contact optional

string

custom_field_value0 optional

string

custom_field_value1 optional

string

custom_field_value2 optional

string

custom_field_value3 optional

string

custom_field_value4 optional

string

custom_field_value5 optional

string

display_name optional

string

display_version optional

string

dont_replicate optional

integer

file_name optional

string

file_size optional

integer

help_link optional

string

help_telephone optional

string

id optional

integer

install_date optional

string

installed_count optional

integer

inventory_rule optional

string

is_manual optional

integer

is_patch optional

integer

notes optional

string

publisher optional

string

quiet_uninstall_string optional

string

readme optional

string

rule_data_type optional

integer

rule_flag optional

integer

threat optional

integer

uninstall_string optional

string

urlinfo_about optional

string

version optional

string

Inventory API Reference

Inventory API Reference

KACE SMA Inventory API Reference

Overview

Version information

Version : 10.0

URI scheme

BasePath : /api/inventory

Consumes

application/json

Produces

application/json

Paths

POST /api/inventory/machines/

Description

Creates or updates inventory data. The only way to send new inventory data is via this Machine entity. It is suggested that POST be used for new machines and PUT for machine updates. However, as a convenience for clients, the POST route can be used to update the inventory for existing machines. See Appendix B for an example of the request body format. Multiple machines can be sent in a single request. If no KUID is given for a machine, one will be auto-generated. The ID(s) of the impacted machines will be included in the response.

Responses

HTTP Code
Schema

200

< integer > array

GET /api/inventory/machines/

Description

Retrieves the data for any matching machines.

Parameters

Type
Name
Description
Schema
Default

Query

filterOptions optional

The name of join set to insert in base query

string

""

Query

filtering optional

string

Query

offset optional

string

Query

paging optional

string

Query

shaping optional

string

Query

sorting optional

string

Query

use_count optional

string

Query

use_count_only optional

string

Query

use_pretty_print optional

boolean

Responses

HTTP Code
Schema

200

< string > array

GET /api/inventory/machines/version/

Description

Returns the latest API version for the entity. If there is no specific version, the overall API version is returned.

Responses

HTTP Code
Schema

200

string

GET /api/inventory/machines/{id}/

Description

Retrieves the data for the specific ID given. All query parameters are available.

Parameters

Type
Name
Schema

Path

id required

integer

Query

shaping optional

string

Query

sorting optional

string

Query

use_count optional

string

Query

use_count_only optional

string

Query

use_pretty_print optional

boolean

Responses

HTTP Code
Schema

200

< string > array

PUT /api/inventory/machines/{id}/

Description

Updates machine inventory data for the given ID. If a KUID is sent in the request body, it must match the KUID for the machine with the given ID. See Appendix B for an example of the request body format.

Responses

HTTP Code
Schema

200

< integer > array

POST /api/inventory/machines/{id}/force/

Parameters

Type
Name
Schema

Path

id required

integer

Responses

HTTP Code
Schema

200

string

POST /api/inventory/nodes/

Responses

HTTP Code
Schema

200

string

GET /api/inventory/nodes/

Description

Retrieves the data for any matching agentless nodes.

Parameters

Type
Name
Schema

Query

filtering optional

string

Query

offset optional

string

Query

paging optional

string

Query

shaping optional

string

Query

sorting optional

string

Query

use_count optional

string

Query

use_count_only optional

string

Query

use_pretty_print optional

boolean

Responses

HTTP Code
Schema

200

< string > array

GET /api/inventory/nodes/version/

Description

Returns the latest API version for the entity. If there is no specific version, the overall API version is returned.

Responses

HTTP Code
Schema

200

string

GET /api/inventory/nodes/{id}/

Description

Retrieves the data for the specific ID given. All query parameters are available.

Parameters

Type
Name
Schema

Path

id required

integer

Query

shaping optional

string

Query

sorting optional

string

Query

use_count optional

string

Query

use_count_only optional

string

Query

use_pretty_print optional

boolean

Responses

HTTP Code
Schema

200

string

POST /api/inventory/operating_systems/

Responses

HTTP Code
Schema

200

string

GET /api/inventory/operating_systems/

Description

Retrieves the data for any matching operating systems. The operating system for a machine are reported during inventory.

Parameters

Type
Name
Schema

Query

filtering optional

string

Query

offset optional

string

Query

paging optional

string

Query

shaping optional

string

Query

sorting optional

string

Query

use_count optional

string

Query

use_count_only optional

string

Query

use_pretty_print optional

boolean

Responses

HTTP Code
Schema

200

< string > array

GET /api/inventory/operating_systems/version/

Description

Returns the latest API version for the entity. If there is no specific version, the overall API version is returned.

Responses

HTTP Code
Schema

200

string

GET /api/inventory/operating_systems/{id}/

Description

Retrieves the data for the specific ID given. All query parameters are available.

Parameters

Type
Name
Schema

Path

id required

integer

Query

shaping optional

string

Query

sorting optional

string

Query

use_count optional

string

Query

use_count_only optional

string

Query

use_pretty_print optional

boolean

Responses

HTTP Code
Schema

200

string

POST /api/inventory/processes/

Responses

HTTP Code
Schema

200

string

GET /api/inventory/processes/

Description

Retrieves the data for any matching processes. The running processes for a machine are reported during inventory.

Parameters

Type
Name
Schema

Query

filtering optional

string

Query

offset optional

string

Query

paging optional

string

Query

shaping optional

string

Query

sorting optional

string

Query

use_count optional

string

Query

use_count_only optional

string

Query

use_pretty_print optional

boolean

Responses

HTTP Code
Schema

200

< string > array

GET /api/inventory/processes/version/

Description

Returns the latest API version for the entity. If there is no specific version, the overall API version is returned.

Responses

HTTP Code
Schema

200

string

GET /api/inventory/processes/{id}/

Description

Retrieves the data for the specific ID given. All query parameters are available.

Parameters

Type
Name
Schema

Path

id required

integer

Query

shaping optional

string

Query

sorting optional

string

Query

use_count optional

string

Query

use_count_only optional

string

Query

use_pretty_print optional

boolean

Responses

HTTP Code
Schema

200

string

POST /api/inventory/services/

Responses

HTTP Code
Schema

200

string

GET /api/inventory/services/

Description

Retrieves the data for any matching NT services. The list of services for a Windows machine are reported during inventory.

Parameters

Type
Name
Schema

Query

filtering optional

string

Query

offset optional

string

Query

paging optional

string

Query

shaping optional

string

Query

sorting optional

string

Query

use_count optional

string

Query

use_count_only optional

string

Query

use_pretty_print optional

boolean

Responses

HTTP Code
Schema

200

< string > array

GET /api/inventory/services/version/

Description

Returns the latest API version for the entity. If there is no specific version, the overall API version is returned.

Responses

HTTP Code
Schema

200

string

GET /api/inventory/services/{id}/

Description

Retrieves the data for the specific ID given. All query parameters are available.

Parameters

Type
Name
Schema

Path

id required

integer

Query

shaping optional

string

Query

sorting optional

string

Query

use_count optional

string

Query

use_count_only optional

string

Query

use_pretty_print optional

boolean

Responses

HTTP Code
Schema

200

string

POST /api/inventory/softwares/

Responses

HTTP Code
Schema

200

string

GET /api/inventory/softwares/

Description

Retrieves the data for any matching software. The installed software titles for a machine are reported during inventory.

Parameters

Type
Name
Schema

Query

filtering optional

string

Query

offset optional

string

Query

paging optional

string

Query

shaping optional

string

Query

sorting optional

string

Query

use_count optional

string

Query

use_count_only optional

string

Query

use_pretty_print optional

boolean

Responses

HTTP Code
Schema

200

< string > array

GET /api/inventory/softwares/version/

Description

Returns the latest API version for the entity. If there is no specific version, the overall API version is returned.

Responses

HTTP Code
Schema

200

string

GET /api/inventory/softwares/{id}/

Description

Retrieves the data for the specific ID given. All query parameters are available.

Parameters

Type
Name
Schema

Path

id required

integer

Query

shaping optional

string

Query

sorting optional

string

Query

use_count optional

string

Query

use_count_only optional

string

Query

use_pretty_print optional

boolean

Responses

HTTP Code
Schema

200

string

POST /api/inventory/startup_programs/

Responses

HTTP Code
Schema

200

string

GET /api/inventory/startup_programs/

Description

Retrieves the data for any matching startup programs. The list of startup programs for a machine are reported during inventory.

Parameters

Type
Name
Schema

Query

filtering optional

string

Query

offset optional

string

Query

paging optional

string

Query

shaping optional

string

Query

sorting optional

string

Query

use_count optional

string

Query

use_count_only optional

string

Query

use_pretty_print optional

boolean

Responses

HTTP Code
Schema

200

< string > array

GET /api/inventory/startup_programs/version/

Description

Returns the latest API version for the entity. If there is no specific version, the overall API version is returned.

Responses

HTTP Code
Schema

200

string

GET /api/inventory/startup_programs/{id}/

Description

Retrieves the data for the specific ID given. All query parameters are available.

Parameters

Type
Name
Schema

Path

id required

integer

Query

shaping optional

string

Query

sorting optional

string

Query

use_count optional

string

Query

use_count_only optional

string

Query

use_pretty_print optional

boolean

Responses

HTTP Code
Schema

200

string

Definitions

Catalog.Sam_Catalog

Name
Schema

Edition optional

string

Id optional

string

Is_Mobile optional

integer

License_Type optional

string

Major_Version optional

string

Name optional

string

Product_Name optional

string

Publisher optional

string

Sam_Type optional

string

Software_Category optional

string

Software_Category_Id optional

integer

Software_Platform optional

string

Software_Platform_Id optional

integer

Support_Url optional

string

Dell_Inventory

Name
Schema

Inv_Log_Xml optional

string

Inv_Out_Xml optional

string

Lang optional

string

Machine_Id optional

integer

Os_Arch optional

string

Os_Code optional

string

Os_Majver optional

integer

Os_Minver optional

integer

Os_Vendor optional

string

Status_Code optional

integer

Status_Phase optional

string

System_Did optional

string

Dell_Inventory_Log

Name
Schema

Failure_Reason optional

string

Machine_Id optional

integer

Module_Id optional

string

Status optional

string

Dell_Machine_Pkg_Update_Status

Name
Schema

Catalog_Id optional

integer

Dell_Schedule_Id optional

integer

Machine_Id optional

integer

Max_Update_Attempt optional

integer

Package_Did optional

string

Update_Count optional

integer

Dell_Machine_Status

Name
Schema

Applicable_Update optional

string

Catalog_Id optional

integer

Device_Id optional

integer

Machine_Id optional

integer

Package_Did optional

string

Dell_Pkg_Update_History

Name
Schema

Applicable_Update optional

string

Catalog_Id optional

integer

Machine_Id optional

integer

Package_Did optional

string

Update_Phase optional

string

Update_Status optional

integer

Fs

Name
Schema

Alt_Checksum optional

string

Alt_Location optional

string

Create_Location optional

integer

Create_Shortcut optional

integer

Credential_Id_Alt_Location optional

integer

Credential_Id_Location optional

integer

Enabled optional

integer

Hour_Begin optional

integer

Hour_End optional

integer

Id optional

integer

Location optional

string

No_Uncompress optional

integer

Notes optional

string

Persistent optional

integer

Postinstall_Message optional

string

Preinstall_Message optional

string

Remove_Files optional

integer

Replace_Existing optional

integer

Shortcut_Name optional

string

Software_Id optional

integer

Target_All_Machines optional

integer

Type optional

string

Kbsys.Patch

Name
Schema

Bulletin optional

string

Bundled_By optional

string

Bundles optional

string

Classification optional

string

Cve optional

string

Description optional

string

Id optional

string

Impact_Install optional

string

Impact_Uninstall optional

string

Info_Url optional

string

Is_Superceded optional

integer

Is_Supported_Install optional

integer

Is_Supported_Uninstall optional

integer

Patch_Guid optional

string

Patch_Identifier optional

string

Patch_Type optional

string

Publisher optional

string

Reboot_Install optional

integer

Reboot_Uninstall optional

integer

Request_User_Input_Install optional

integer

Request_User_Input_Uninstall optional

integer

Required_By optional

string

Requires optional

string

Severity optional

string

Superceded_By optional

string

Supercedes optional

string

Title optional

string

Label

Name
Schema

App_Ctrl_Enabled optional

integer

Id optional

integer

Kace_Alt_Location optional

string

Kace_Alt_Location_Password_Enc optional

string

Kace_Alt_Location_User optional

string

Meter_Enabled optional

integer

Name optional

string

Notes optional

string

Scope_User_Role_Id optional

integer

Type optional

string

Usage_All optional

integer

Usage_Catalog optional

integer

Usage_Dell optional

integer

Usage_Label optional

integer

Usage_Machine optional

integer

Usage_Node optional

integer

Usage_Patch optional

integer

Usage_Process optional

integer

Usage_Software optional

integer

Usage_User optional

integer

Machine

Name
Schema

Asset_Tag optional

string

Bios_Description optional

string

Bios_Identification_Code optional

string

Bios_Manufacturer optional

string

Bios_Name optional

string

Bios_Serial_Number optional

string

Bios_Version optional

string

Cdrom_Devices optional

string

Chassis_Type optional

string

Client_Version optional

string

Cpu_Name optional

string

Cs_Domain optional

string

Cs_Manufacturer optional

string

Cs_Model optional

string

Csp_Id_Number optional

string

Custom_Field_Value0 optional

string

Custom_Field_Value1 optional

string

Custom_Field_Value2 optional

string

Custom_Field_Value3 optional

string

Custom_Field_Value4 optional

string

Custom_Field_Value5 optional

string

Domain optional

string

Dot_Net_Versions optional

string

Force_Inventory optional

integer

Id optional

integer

Ie_Version optional

string

Ip optional

string

Ipv6 optional

string

Kpatch_Language_Id optional

string

Kuid optional

string

Last_Reboot optional

string

Last_Shutdown optional

string

Last_User optional

string

Mac optional

string

Manual_Entry optional

integer

Manufacturer_Product_Number optional

string

Monitor optional

string

Motherboard_Primary_Bus optional

string

Motherboard_Secondary_Bus optional

string

Name optional

string

Netmask optional

string

Notes optional

string

Os_Arch optional

string

Os_Build optional

string

Os_Family optional

string

Os_Id optional

integer

Os_Installed_Date optional

string

Os_Major optional

string

Os_Minor optional

string

Os_Minor2 optional

string

Os_Name optional

string

Os_Number optional

string

Os_Release optional

string

Os_Version optional

string

Ownership optional

string

Pagefile_Max_Size optional

string

Pagefile_Size optional

string

Physical_Cores optional

integer

Physical_Processors optional

integer

Prefix_Len optional

integer

Printers optional

string

Processors optional

string

Ram_Max optional

string

Registry_Max_Size optional

string

Registry_Size optional

string

Sda_Deployment_Name optional

string

Sda_Deployment_Time optional

string

Sda_Deployment_Type optional

string

Sda_Deployment_Url optional

string

Sda_Installation_Id optional

string

Sda_Name optional

string

Sda_Url optional

string

Service_Pack optional

string

Sound_Devices optional

string

Sys_Arch optional

string

System_Description optional

string

System_Directory optional

string

Tz_Agent optional

string

Uptime optional

string

User optional

string

User_Domain optional

string

User_Fullname optional

string

User_Logged optional

string

User_Name optional

string

Video_Controllers optional

string

Virtual optional

string

Wmi_Status optional

string

Machine_Bitlocker_Volume

Name
Schema

Conversion_Status optional

string

Device_Id optional

string

Drive_Letter optional

string

Encryption_Method optional

string

Encryption_Percentage optional

integer

Hardware_Encryption_Status optional

string

Id optional

integer

Identification_Field optional

string

Is_System_Volume optional

integer

Key_Protectors optional

string

Lock_Status optional

string

Persistent_Volume_Id optional

string

Protection_Status optional

string

Self_Encryption_Drive_Encryption_Method optional

string

Version optional

integer

Wiping_Percentage optional

integer

Wiping_Status optional

string

Machine_Chromeos_Details

Name
Schema

Annotated_Location optional

string

Annotated_User optional

string

Boot_Mode optional

string

Device_Id optional

string

Firmware_Version optional

string

Id optional

integer

Mac_Address optional

string

Machine_Chromeos_Details_Id optional

integer

Meid optional

string

Model optional

string

Notes optional

string

Order_Number optional

string

Org_Unit_Path optional

string

Os_Version optional

string

Platform_Version optional

string

Serial_Number optional

string

Status optional

string

Will_Auto_Renew optional

integer

Machine_Custom_Inventory

Name
Schema

Field_Value_Type optional

integer

Id optional

integer

Num_Field_Value optional

integer

Software_Id optional

integer

Str_Field_Value optional

string

Machine_Daily_Uptime

Name
Schema

Id optional

integer

Machine_Id optional

integer

Machine_Ddpe

Name
Schema

Agent_Version optional

string

Id optional

integer

Mcid optional

string

Protection_Status optional

string

Server_Hostname optional

string

Machine_Ddpe_Volume

Name
Schema

Device_Id optional

string

Id optional

integer

Protection_Reason optional

string

Protection_Status optional

string

Machine_Disks

Name
Schema

Id optional

integer

Name optional

string

Machine_Drive_Encryption_Summary

Name
Schema

Id optional

integer

Is_Drive_Encryption_Enabled optional

integer

Is_Drive_Protected optional

integer

Protection_Reason optional

string

Machine_Filevault_Volume

Name
Schema

Authorized_Users optional

string

Conversion_Percentage optional

integer

Conversion_Status optional

string

Device_Id optional

string

Encryption_Status optional

string

Encryption_Type optional

string

Has_Institutional_Recovery_Key optional

integer

Has_Personal_Recovery_Key optional

integer

Id optional

integer

Is_Enabled optional

integer

Version optional

string

Machine_Intel_Amt

Name
Schema

Configuration_Mode optional

string

Control_Mode optional

string

Fw_Version optional

string

Id optional

integer

Is_Amt_Configured optional

integer

Is_Amt_Enabled_In_Bios optional

integer

Is_Amt_Supported optional

integer

Is_Mei_Enabled optional

integer

Mei_Version optional

string

Sku optional

string

State optional

string

Version optional

string

Machine_Location

Name
Schema

Counrty optional

string

Country_Code optional

string

Id optional

integer

Locality optional

string

Machine_Location_Id optional

integer

Postal_Code optional

string

Region optional

string

Street_Address optional

string

Machine_Mobile

Name
Schema

Activation_Lock_Allowed optional

integer

Activation_Lock_Bypass_Code optional

string

Activation_Lock_Enabled optional

integer

Battery_Level optional

string

Carrier optional

string

Current_Carrier_Network optional

string

Data_Roaming_Enabled optional

integer

Dep_Assigned_By optional

string

Dep_Profile optional

string

Dep_Profile_Status optional

string

Device_Type optional

string

Do_Not_Disturb_Enabled optional

integer

Eas_Device_Id optional

string

Iccid optional

string

Icloud_Enabled optional

integer

Id optional

integer

Imei optional

string

Is_Compliant optional

integer

Is_Dep_Configured optional

integer

Is_Dep_Managed optional

integer

Is_Encrypted optional

integer

Is_Enrolled optional

integer

Is_Itunes_Account_Active optional

integer

Is_Lost optional

integer

Is_Rooted optional

integer

Is_Supervised optional

integer

Locator_Service_Enabled optional

integer

Machine_Mobile_Id optional

integer

Meid optional

string

Modem_Firmware optional

string

Phone_Number optional

string

Udid optional

string

Voice_Roaming_Enabled optional

integer

Wifi_Bytes_Recv optional

integer

Wifi_Bytes_Sent optional

integer

Wwan_Bytes_Recv optional

integer

Wwan_Bytes_Sent optional

integer

Machine_Nics

Name
Schema

Dhcp_Enabled optional

string

Dnsdoman optional

string

Dnshostname optional

string

Id optional

integer

Ip optional

string

Ipv6_Config optional

string

Mac optional

string

Netmask optional

string

Nic optional

string

Nic_Id optional

integer

Machine_Replitem

Name
Schema

Checksum optional

string

Error optional

integer

File_Name optional

string

File_Size optional

integer

Machine_Id optional

integer

Ordinal optional

integer

Path optional

string

Type optional

string

Type_Id optional

string

Zip_Package optional

string

Machine_Snmp_Data

Name
Schema

Full_Walk optional

string

Machine_Id optional

integer

Machine_Snmp_Data_Id optional

integer

Machine_Tpm

Name
Schema

Id optional

integer

Is_Activated optional

integer

Is_Enabled optional

integer

Is_Owned optional

integer

Manufacturer_Id optional

integer

Manufacturer_Id_Text optional

string

Manufacturer_Version optional

string

Manufacturer_Version_Info optional

string

Physical_Presence_Version_Info optional

string

Specification_Version optional

string

Mi_Attempt

Name
Schema

Attempt_Count optional

integer

Machine_Id optional

integer

Mi_Id optional

integer

Run_Now optional

integer

Node

Name
Schema

Aw_Id optional

string

Aw_Status optional

integer

Chromeos_Id optional

string

Chromeos_Status optional

integer

Cli_Status optional

integer

Dmm_Id optional

string

Dmm_Status optional

integer

G_Mobile_Id optional

string

G_Mobile_Status optional

integer

Host_Name optional

string

Id optional

integer

Ip optional

string

Kmm_Id optional

string

Kmm_Status optional

integer

Ldap_Status optional

integer

Mac optional

string

Machine_Id optional

integer

Nmap_Status optional

integer

Os_Type optional

string

Ping_Status optional

integer

Real_Name optional

string

Relay_Machine_Id optional

integer

Scan_Settings_Id optional

integer

Snmp_Contact optional

string

Snmp_Status optional

integer

Snmp_Sysdescr optional

string

Snmp_Uptime optional

string

Snmp_Version optional

integer

Snmp_Walk_Data optional

string

Socket_Status optional

integer

Vmware_Status optional

integer

Vmware_Type optional

integer

Winrm_Status optional

integer

Node_Snmp_If

Name
Schema

Admin_Status optional

string

Descr optional

string

Id optional

integer

Ifindex optional

integer

In_Discards optional

integer

In_Errors optional

integer

In_Nucastpkts optional

integer

In_Octets optional

integer

In_Ucastpkts optional

integer

In_Unknownprotos optional

integer

Last_Change optional

string

Mtu optional

integer

Oper_Status optional

string

Out_Discards optional

integer

Out_Errors optional

integer

Out_Nucastpkts optional

integer

Out_Octets optional

integer

Out_Ucastpkts optional

integer

Phys_Address optional

string

Specific optional

string

Speed optional

integer

Type optional

string

Node_Snmp_System

Name
Schema

Contact optional

string

Description optional

string

Full_Walk optional

string

Id optional

integer

Location optional

string

Name optional

string

Object_Id optional

string

Uptime optional

string

Ntservice

Name
Schema

Can_Interact_With_Desktop optional

string

Category optional

string

Command_Args optional

string

Command_Exe optional

string

Company_Name optional

string

Description optional

string

Display_Name optional

string

File_Description optional

string

File_Name optional

string

File_Version optional

string

Id optional

integer

Logon_As_User optional

string

Name optional

string

Notes optional

string

Product_Name optional

string

Product_Version optional

string

Startup_Type optional

string

Status optional

string

Threat optional

integer

Operating_Systems

Name
Schema

Arch optional

string

Build optional

string

Common_Name optional

string

Description optional

string

Family optional

string

Id optional

integer

Major_Version optional

integer

Managed optional

integer

Minor2_Version optional

integer

Minor_Version optional

integer

Name optional

string

Os_Family_Id optional

integer

Os_Product_Id optional

integer

Patch_Package_Code optional

string

Sp optional

integer

Patch_Machine_Status

Name
Schema

Deploy_Attempt_Count optional

integer

Deploy_Error_Code optional

integer

Deploy_Status optional

string

Detect_Error_Code optional

integer

Detect_Rdesc optional

string

Detect_Status optional

string

Is_Error optional

integer

Machine_Id optional

integer

Max_Deploy_Attempt optional

integer

Max_Rollback_Attempt optional

integer

Patch_Applicable optional

integer

Patch_Id optional

string

Patch_Installed optional

integer

Product_Installed optional

integer

Rollback_Attempt_Count optional

integer

Rollback_Error_Code optional

integer

Rollback_Status optional

string

Patch_Schedule_Run_Machine

Name
Schema

Id optional

integer

Machine_Id optional

integer

Patch_Schedule_Id optional

integer

Patch_Schedule_Run_Id optional

integer

Status optional

string

Process

Name
Schema

Category optional

string

Command_Args optional

string

Command_Exe optional

string

Company_Name optional

string

File_Description optional

string

File_Name optional

string

File_Version optional

string

Id optional

integer

Name optional

string

Notes optional

string

Product_Name optional

string

Product_Version optional

string

Threat optional

integer

Sam_Meter

Name
Schema

Id optional

integer

Last_Report optional

string

Machine_Id optional

integer

Sam_Meter_Data

Name
Schema

Id optional

integer

Is_Mobile optional

integer

Latest_Entry optional

integer

Launches optional

integer

Machine_Id optional

integer

Process_Id optional

string

Seconds_Used optional

integer

Titled_Application_Id optional

string

User_Data optional

string

Version optional

string

Software

Name
Schema

Category optional

string

Checksum optional

string

Comments optional

string

Contact optional

string

Custom_Field_Value0 optional

string

Custom_Field_Value1 optional

string

Custom_Field_Value2 optional

string

Custom_Field_Value3 optional

string

Custom_Field_Value4 optional

string

Custom_Field_Value5 optional

string

Display_Name optional

string

Display_Version optional

string

Dont_Replicate optional

integer

File_Name optional

string

File_Size optional

integer

Help_Link optional

string

Help_Telephone optional

string

Id optional

integer

Install_Date optional

string

Inventory_Rule optional

string

Is_Manual optional

integer

Is_Patch optional

integer

Notes optional

string

Publisher optional

string

Quiet_Uninstall_String optional

string

Readme optional

string

Rule_Data_Type optional

integer

Rule_Flag optional

integer

Threat optional

integer

Uninstall_String optional

string

Urlinfo_About optional

string

Version optional

string

Startupprogram

Name
Schema

Category optional

string

Command_Args optional

string

Command_Exe optional

string

Company_Name optional

string

File_Description optional

string

File_Name optional

string

File_Version optional

string

Id optional

integer

Name optional

string

Notes optional

string

Product_Name optional

string

Product_Version optional

string

Threat optional

integer

Managed Install API Reference

Managed Install API Reference

KACE SMA Managed Install API Reference

Overview

Version information

Version : 10.0

URI scheme

BasePath : /api/mi

Consumes

application/json

Produces

application/json

Paths

PUT /api/managed_install/managed_installs/{id}/add_to_machines

Description

Adds devices to a managed install.

Parameters

Type
Name
Description
Schema

Path

id required

integer

Query

use_count optional

string

Query

use_count_only optional

string

Query

use_pretty_print optional

boolean

Body

machines required

A payload with the machines to update. For example: { "Machines" : ["id"]}

json

Responses

HTTP Code
Schema

200

No Content

GET /api/mi/compatible_machines

Description

Returns a list of compatible machines

Parameters

Type
Name
Schema

Query

filtering optional

string

Query

offset optional

string

Query

paging optional

string

Query

shaping optional

string

Query

sorting optional

string

Query

use_count optional

string

Query

use_count_only optional

string

Query

use_pretty_print optional

boolean

Responses

HTTP Code
Schema

200

< string > array

GET /api/mi/compatible_machines/version

Description

Returns the API version for this endpoint.

Responses

HTTP Code
Schema

200

string

GET /api/mi/files

Description

Returns the list of files available to managed installs.

Parameters

Type
Name
Schema

Query

filtering optional

string

Responses

HTTP Code
Schema

200

< string > array

GET /api/mi/files/version

Description

Returns the version of this api endpoint.

Responses

HTTP Code
Schema

200

string

GET /api/mi/machines

Description

Returns all the devices

Parameters

Type
Name
Schema

Query

filtering optional

string

Query

offset optional

string

Query

paging optional

string

Query

shaping optional

string

Query

sorting optional

string

Query

use_count optional

string

Query

use_count_only optional

string

Query

use_pretty_print optional

boolean

Responses

HTTP Code
Schema

200

< string > array

GET /api/mi/machines/version

Description

Returns the version for this end point.

Responses

HTTP Code
Schema

200

string

GET /api/mi/machines/{id}

Description

Returns the managed install associated with a device.

Parameters

Type
Name
Schema

Path

id required

integer

Query

shaping optional

string

Query

sorting optional

string

Query

use_count optional

string

Query

use_count_only optional

string

Query

use_pretty_print optional

boolean

Responses

HTTP Code
Schema

200

< string > array

GET /api/mi/managed_installs

Description

Returns a list of all managed installs.

Parameters

Type
Name
Schema

Query

filtering optional

string

Query

offset optional

string

Query

paging optional

string

Query

shaping optional

string

Query

sorting optional

string

Query

use_count optional

string

Query

use_count_only optional

string

Query

use_pretty_print optional

boolean

Responses

HTTP Code
Schema

200

< string > array

GET /api/mi/managed_installs/version

Description

Returns the current version of this API endpoint.

Responses

HTTP Code
Schema

200

string

GET /api/mi/managed_installs/{id}

Description

Gets the details of this managed install

Parameters

Type
Name
Schema

Path

id required

integer

Query

shaping optional

string

Query

sorting optional

string

Query

use_count optional

string

Query

use_count_only optional

string

Query

use_pretty_print optional

boolean

Responses

HTTP Code
Schema

200

string

GET /api/mi/managed_installs/{id}/compatible_machines

Description

Returns a list of compatible devices for this managed install.

Parameters

Type
Name
Schema

Path

id required

integer

Query

filtering optional

string

Query

shaping optional

string

Query

sorting optional

string

Query

use_count optional

string

Query

use_count_only optional

string

Query

use_pretty_print optional

boolean

Responses

HTTP Code
Schema

200

< string > array

GET /api/mi/managed_installs/{id}/file

Description

Gets the file associated with this managed install.

Parameters

Type
Name
Schema

Path

id required

integer

Query

shaping optional

string

Query

sorting optional

string

Query

use_count optional

string

Query

use_count_only optional

string

Query

use_pretty_print optional

boolean

Responses

HTTP Code
Schema

200

string

PUT /api/mi/managed_installs/{id}/remove_from_machines

Description

Removed devices from a managed install.

Parameters

Type
Name
Description
Schema

Path

id required

integer

Query

use_count optional

string

Query

use_count_only optional

string

Query

use_pretty_print optional

boolean

Body

machines required

A payload with the machines to update

json

Responses

HTTP Code
Schema

200

No Content

Verwandte Dokumente