KACE SMA 8.0 – API Reference Guide

















About the KACE Systems Management Appliance API



The KACE Systems Management Appliance (SMA) API allows you to manage various aspects of the KACE SMA appliance data and its related information.


CAUTION: This API Reference Guide

is available only to those users who have a technical understanding of how to use the information provided in this document. Our Support team does not provide assistance for any custom development that implements the APIs covered in this guide which is in line with our support policy. For more information, visit:

https://support.quest.com/essentials/support-guide

.

Authentication and organization selection

Authentication and organization selection

Access to the KACE SMA API is limited to authenticated KACE SMA users. If the appliance is configured for multiple organizations, querying is limited to the currently selected organization for the requesting user.

Authentication and organization selection are available through the KACE SMA Account Management Service. The authentication route is accessed through a POST request at /ams/shared/api/security/login. So for example, if the appliance name is KACE_SMA_Test, the route to login can be: http://KACE_SMA_Test/ams/shared/api/security/login.

The body for the POST request must contain the user name and password, and optionally an organization name. Here is an example body for that request:


Authorization

Authorization

During authentication, the assigned role is retrieved for the given KACE SMA user. This role determines the actions that the user is authorized to perform. With regard to this API, the following default roles have specific capabilities.



Administrator

: All API actions are available. In queries, matching data for all users is returned.




Standard user

: All API queries are available. Matching data is returned only for the current user.

If the appliance is updated with custom roles and the current user is assigned one of those roles, its permissions are retrieved. These permission values are used to determine the user’s querying capability for this API. For more information about the KACE SMA roles, see the K1000 Systems Management Appliance Administrator Guide.

Access

Access

The API is available at the K1000 address starting with the path /api.

So for example, if the K1000 name in your environment is K1000Test, the route to the machine entities would be http://K1000Test/api/inventory/machines.





















The Quest Software Portal no longer supports IE8, 9, & 10 and it is recommended to upgrade your browser to the latest version of Internet Explorer or Chrome.

Upgrade to IE 11 Click here

Upgrade to Chrome Click here

If you continue in IE8, 9, or 10 you will not be able to take full advantage of all our great self service features.








Source

Leave a comment

Your email address will not be published. Required fields are marked *