Verifying API connection with Postman (4288264)

The KACE Systems Management Appliance (SMA) API allows you to manage various aspects of the KACE SMA appliance data and its related information.  This article only covers basic instructions with one API tool and is provided as one example of how to establish an initial connection.  For additional information, please refer to the API Reference Guide, which is located on the technical documents page for the SMA.

NOTE: KACE Support is only able to assist with ensuring basic functionality of the API.  For assistance with writing custom API, please contact Professional Services.  This is a fee-based service.

Additional API related articles may be available in our knowledge base or on ITNinja

To establish a connection with API:

1. Open Postman and click New

Click To See Full Image.

2. Click on HTTP Request

Click To See Full Image.

3. Click on the New Request created.
4. Change the Request to a POST and use the following format to authenticate:
   • URL: http://YourSMAFQDNorIP/ams/shared/api/security/login
   • URL with SSL: https://YourSMAFQDNorIP/ams/shared/api/security/login
5. Create the three necessary headers with the following key : value
   • Content-Type : application/json
   • Accept : application/json
   • x-kace-api-version: 5 (or greater)

Click To See Full Image.

6. Create the appropriate body:
   • Choose Body and choose Raw
   • Enter the following body (Variable are case sensitive):
     1. ORG-enabled box: {"userName": "admin","password": "admin","organizationName": "Default"}
     2. non-ORG box: {"userName": "admin","password": "admin"}

Click To See Full Image.

7. Click Send
8. Verify the Status is 200 OK

Click To See Full Image.

NOTE:  The above login example and information returned on the user both establishes and verifies that API is connected.  Use the API Reference Guide for additional information on API.