Chat now with support
Chat with Support

KACE Systems Management Appliance 12.0 Common Documents - API Reference Guide

Login example

Login example

Syntax:

•
Type: POST
•
URL: {host}/ams/shared/api/security/login
•
Headers:
◦
Content-Type:application/json
◦
Accept:application/json
•
Body:
◦
{"userName": "{username}", "password": "{password}"}

Example:

•
Type: POST
•
URL: k1000/ams/shared/api/security/login
•
Headers:
◦
Content-Type:application/json
◦
Accept:application/json
•
Body:
◦
{"userName": "admin", "password": "123456"}

Update a location example

Update a location example

Syntax:

•
Type: PUT
•
URL: {host}/ams/shared/api/locations/{id}
•
Headers:
◦
Content-Type:application/json
◦
Accept:application/json
◦
x-kace-csrf-token:{token}
◦
x-kace-api-version:5
•
Body:

{

"name": "{asset name}",

"description": "{description}",

"webSite": "{webSite}",

"address": "{address}",

"phoneNumber": "{phone number}",

"organizationId": 2

}

Example:

* 
NOTE: This example updates the description, website, address, and phone number for the location “Oklahoma” whose ID is '3'. The location ID ('3') must be specified in the URL, and the location name ("Oklahoma") must be in the body.
•
Type: PUT
•
URL: k1000/ams/shared/api/locations/3
•
Headers:
◦
Content-Type:application/json
◦
Accept:application/json
◦
x-kace-csrf-token:

• 0f0af166283d60b9e0b4697d9fac83a2a0a74aeb7840714dae71b9f993a3aa1fbe8736607

• e89511cf6b833e313b0d12d030ef866a85cf2c0db175e29c7b31da7

◦
x-kace-api-version:5
•
Body:

{

"name": "Oklahoma",

"description": "OK",

"webSite": "www.example.com",

"address": "123 Main St.",

"phoneNumber": "555-555-5555",

"organizationId": 2

}

Create an inventory example

Create an inventory example

Syntax:

•
Type: POST
•
URL: {host}/api/inventory/machines
•
Headers:
◦
Content-Type:application/json
◦
Accept:application/json
◦
x-kace-csrf-token:{token}
◦
x-kace-api-version:5
•
Body:

{

"Machines": [

{

"Name":"{system name}",

"Ip":"{ip address}",

"Os_number":"{os number}",

"User":"{user}",

"Cdrom_devices":"{cd rom device}",

"Os_name":"{os name}",

"Ram Total":"{ram total}",

"Ram_used":"{ram used}",

"Pagefile_max_size":"{pagefile max size}",

"Ram_max":"{ram max}",

"Bios_identification_code":"{bios id code}",

"Monitor":"{monitor}",

"Sound_devices":"{sound device}",

"Video_controllers":"{video controller}",

"Pagefile_size":"{pagefile size}"

}

]

}

Example:

* 
NOTE: This example creates a machine in the inventory given the field values below.
•
Type: POST
•
URL: k1000/api/inventory/machines
•
Headers:
◦
Content-Type:application/json
◦
Accept:application/json
◦
x-kace-csrf-token:

• 0f0af166283d60b9e0b4697d9fac83a2a0a74aeb7840714dae71b9f993a3aa1fbe8736607

• e89511cf6b833e313b0d12d030ef866a85cf2c0db175e29c7b31da7

◦
x-kace-api-version:5
•
Body:

{

"Machines": [

{

"Name":" Workstation 123",

"Ip":"192.168.101.110",

"Os_number":"10.0.14393",

"User":"user1",

"Cdrom_devices":"NECVMWar VMware SATA CD01",

"Os_name":"Microsoft Windows 10 Pro x64",

"Ram Total":"2048 Bytes",

"Ram_used":"1324.1",

"Pagefile_max_size":"385",

"Ram_max":"33792",

"Bios_identification_code":"",

"Monitor":"Generic Non-PnP Monitor",

"Sound_devices":"High Definition Audio Device",

"Video_controllers":"VMware SVGA 3D:1024 MB",

"Pagefile_size":"385"

}

]

}

Query examples

Query examples

For reference, here is an example of a query that uses most of the parameters described in this section.

/machines?shaping=machine all,software
limited&sorting=software.name
desc&use_count=false&filtering=id lt 1000&paging=limit
1

To retrieve tickets, along with their submitter and owner details (if available):

GET /api/service_desk/tickets?shaping=
hd_ticket regular,owner limited,submitter limited

To retrieve ticket changes and comments, including attachment IDs, and author comments:

GET /api/service_desk/tickets/24/changes?shaping=
hd_ticket_change regular,attachments regular,user limited

To retrieve an attachment associated with a ticket change:

GET /api/service_desk/tickets/24/changes/26/
attachments/18
Related Documents

The document was helpful.

Select Rating

I easily found the information I needed.

Select Rating