Kandji
App · 20 actions
Read device inventory, Blueprints and directory users, update device assignments, and manage device notes.
Actions
| Action | What it does |
|---|---|
| Create device note | Create device note. |
| Delete device note | Delete device note. |
| Get blueprint | Get blueprint. |
| Get device | Get device. |
| Get device activity | Get device activity. |
| Get device apps | Get device apps. |
| Get device details | Get device details. |
| Get device note | Get device note. |
| Get device status | Get device status. |
| Get user | Get user. |
| List blueprints | List blueprints. |
| List custom apps | List custom apps. |
| List custom profiles | List custom profiles. |
| List custom scripts | List custom scripts. |
| List device notes | List device notes. |
| List devices | List devices. |
| List tags | List tags. |
| List users | List users. |
| Update device | Update device. |
| Update device note | Update device note. |
Create device note
Create device note.
Inputs
- Device
device_idtextRequired - Device id.
- Content
contenttextRequired - The text of the device note.
Outputs
Result.
dataobject- Complete service response.
has_moretrue/false- Whether another page is available.
next_cursortext- Continuation value for the next page.
Example output
{
"data": {
"author": "",
"content": "",
"created_at": "",
"note_id": "",
"updated_at": ""
},
"has_more": false,
"next_cursor": null
}Delete device note
Delete device note.
Inputs
- Device
device_idtextRequired - Device id.
- Note id
note_idtextRequired - Note id.
Outputs
Result.
dataobject- Complete service response.
has_moretrue/false- Whether another page is available.
next_cursortext- Continuation value for the next page.
Example output
{
"data": {
"deleted_at": "",
"note_id": ""
},
"has_more": false,
"next_cursor": null
}Get blueprint
Get blueprint.
Inputs
- Blueprint
blueprint_idtextRequired - Blueprint id.
Outputs
Result.
dataobject- Complete service response.
has_moretrue/false- Whether another page is available.
next_cursortext- Continuation value for the next page.
Example output
{
"data": {},
"has_more": false,
"next_cursor": null
}Get device
Get device.
Inputs
- Device
device_idtextRequired - Device id.
Outputs
Result.
dataobject- Complete service response.
has_moretrue/false- Whether another page is available.
next_cursortext- Continuation value for the next page.
Example output
{
"data": {
"agent_installed": "",
"agent_version": "",
"asset_tag": "",
"blueprint_id": "",
"blueprint_name": "",
"device_id": "",
"device_name": "",
"first_enrollment": "",
"is_missing": "",
"is_removed": "",
"last_check_in": "",
"last_enrollment": "",
"mdm_enabled": "",
"model": "",
"os_version": "",
"platform": "",
"serial_number": "",
"supplemental_build_version": "",
"supplemental_os_version_extra": "",
"tags": [],
"user": {}
},
"has_more": false,
"next_cursor": null
}Get device activity
Get device activity.
Inputs
- Device
device_idtextRequired - Device id.
- Limit
limitnumber - A hard upper limit is set at 300 device records returned per request. If more device records are expected, pagination should be used using the limit and offset parameters. Additionally, parameter queries can be added to a request to limit the results.From 1 to 300.
- Offset
offsetnumber - Specify the starting record to returnFrom 0 to 2147483647.
Outputs
Result.
dataobject- Complete service response.
has_moretrue/false- Whether another page is available.
next_cursortext- Continuation value for the next page.
Example output
{
"data": {
"activity": {},
"device_id": ""
},
"has_more": false,
"next_cursor": null
}Get device apps
Get device apps.
Inputs
- Device
device_idtextRequired - Device id.
Outputs
Result.
dataobject- Complete service response.
has_moretrue/false- Whether another page is available.
next_cursortext- Continuation value for the next page.
Example output
{
"data": {
"apps": [],
"device_id": ""
},
"has_more": false,
"next_cursor": null
}Get device details
Get device details.
Inputs
- Device
device_idtextRequired - Device id.
Outputs
Result.
dataobject- Complete service response.
has_moretrue/false- Whether another page is available.
next_cursortext- Continuation value for the next page.
Example output
{
"data": {},
"has_more": false,
"next_cursor": null
}Get device note
Get device note.
Inputs
- Device
device_idtextRequired - Device id.
- Note id
note_idtextRequired - Note id.
Outputs
Result.
dataobject- Complete service response.
has_moretrue/false- Whether another page is available.
next_cursortext- Continuation value for the next page.
Example output
{
"data": {
"author": "",
"content": "",
"created_at": "",
"note_id": "",
"updated_at": ""
},
"has_more": false,
"next_cursor": null
}Get device status
Get device status.
Inputs
- Device
device_idtextRequired - Device id.
Outputs
Result.
dataobject- Complete service response.
has_moretrue/false- Whether another page is available.
next_cursortext- Continuation value for the next page.
Example output
{
"data": {
"device_id": "",
"library_items": [],
"parameters": []
},
"has_more": false,
"next_cursor": null
}Get user
Get user.
Inputs
- User
record_user_idtextRequired - User id.
Outputs
Result.
dataobject- Complete service response.
has_moretrue/false- Whether another page is available.
next_cursortext- Continuation value for the next page.
Example output
{
"data": {
"active": "",
"archived": "",
"created_at": "",
"department": "",
"deprecated_user_id": "",
"device_count": "",
"email": "",
"id": "",
"integration": {},
"job_title": "",
"name": "",
"updated_at": ""
},
"has_more": false,
"next_cursor": null
}List blueprints
List blueprints. Returns one page; use the continuation value for more records.
Inputs
- Name
nametext - Return Blueprint names "containing" the specified search string.
- Limit
limitnumber - Number of results to return per page.From 1 to 300.
- Offset
offsetnumber - The initial index from which to return the results.From 0 to 2147483647.
Outputs
Result.
dataobject- Complete service response.
has_moretrue/false- Whether another page is available.
next_cursortext- Continuation value for the next page.
Example output
{
"data": {
"count": "",
"next": "",
"previous": "",
"results": []
},
"has_more": false,
"next_cursor": null
}List custom apps
List custom apps.
Inputs
- Next page URL
next_pagetext - The continuation URL from the previous result. Leave empty for the first page.
Outputs
Result.
dataobject- Complete service response.
has_moretrue/false- Whether another page is available.
next_cursortext- Continuation value for the next page.
Example output
{
"data": {
"count": "",
"next": "",
"previous": "",
"results": []
},
"has_more": false,
"next_cursor": null
}List custom profiles
List custom profiles.
Inputs
- Next page URL
next_pagetext - The continuation URL from the previous result. Leave empty for the first page.
Outputs
Result.
dataobject- Complete service response.
has_moretrue/false- Whether another page is available.
next_cursortext- Continuation value for the next page.
Example output
{
"data": {
"count": "",
"next": "",
"previous": "",
"results": []
},
"has_more": false,
"next_cursor": null
}List custom scripts
List custom scripts.
Inputs
- Next page URL
next_pagetext - The continuation URL from the previous result. Leave empty for the first page.
Outputs
Result.
dataobject- Complete service response.
has_moretrue/false- Whether another page is available.
next_cursortext- Continuation value for the next page.
Example output
{
"data": {
"count": "",
"next": "",
"previous": "",
"results": []
},
"has_more": false,
"next_cursor": null
}List device notes
List device notes.
Inputs
- Device
device_idtextRequired - Device id.
Outputs
Result.
datalist- Complete service response.
has_moretrue/false- Whether another page is available.
next_cursortext- Continuation value for the next page.
Example output
{
"data": [],
"has_more": false,
"next_cursor": null
}List devices
List devices. Returns one page; use the continuation value for more records.
Inputs
- Blueprint
blueprint_idtext - Return results "containing" the specified blueprint id
- Device name
device_nametext - device_name.
- Limit
limitnumber - A hard upper limit is set at 300 device records returned per request. If more device records are expected, pagination should be used using the limit and offset parameters. Additionally, parameter queries can be added to a request to limit the results.From 1 to 300.
- Offset
offsetnumber - Specify the starting record to returnFrom 0 to 2147483647.
Outputs
Result.
datalist- Complete service response.
has_moretrue/false- Whether another page is available.
next_cursortext- Continuation value for the next page.
Example output
{
"data": [],
"has_more": false,
"next_cursor": null
}List tags
List tags.
Inputs
- Search
searchtext - Return resultes containing a given tag search string.
- Next page URL
next_pagetext - The continuation URL from the previous result. Leave empty for the first page.
Outputs
Result.
dataobject- Complete service response.
has_moretrue/false- Whether another page is available.
next_cursortext- Continuation value for the next page.
Example output
{
"data": {
"count": "",
"next": "",
"previous": "",
"results": []
},
"has_more": false,
"next_cursor": null
}List users
List users. Returns one page; use the continuation value for more records.
Inputs
- Email
emailtext - Returns users with email addresses containing the provided string.
- Archived
archivedtrue/false - Return only users that are either archived (true) or not archived (false). Archived users are users that appear in the Users module under the Archived tab.
- Cursor
cursortext - Cursor for the next or previous page of results. Can also store the URL in the next and previous fields in the response.
- Size per page
size_per_pagenumber - Adjusts the number of records to return per page for large data sets. Defaults to 25, supports a maximum number of 300 records per page.From 1 to 300.
Outputs
Result.
dataobject- Complete service response.
has_moretrue/false- Whether another page is available.
next_cursortext- Continuation value for the next page.
Example output
{
"data": {
"next": "",
"previous": "",
"results": []
},
"has_more": false,
"next_cursor": null
}Update device
Update device.
Inputs
- Device
device_idtextRequired - Device id.
- Asset tag
asset_tagtext - Asset tag.
- Blueprint
blueprint_idtext - Blueprint id.
- User
usertext - Directory user UUID.
- Tags
tagslist - Tags.
Outputs
Result.
dataobject- Complete service response.
has_moretrue/false- Whether another page is available.
next_cursortext- Continuation value for the next page.
Example output
{
"data": {
"agent_installed": "",
"agent_version": "",
"asset_tag": "",
"blueprint_id": "",
"blueprint_name": "",
"device_id": "",
"device_name": "",
"first_enrollment": "",
"is_missing": "",
"is_removed": "",
"last_check_in": "",
"last_enrollment": "",
"mdm_enabled": "",
"model": "",
"os_version": "",
"platform": "",
"serial_number": "",
"tags": [],
"user": {}
},
"has_more": false,
"next_cursor": null
}Update device note
Update device note.
Inputs
- Device
device_idtextRequired - Device id.
- Note id
note_idtextRequired - Note id.
- Content
contenttextRequired - The text of the device note.
Outputs
Result.
dataobject- Complete service response.
has_moretrue/false- Whether another page is available.
next_cursortext- Continuation value for the next page.
Example output
{
"data": {
"author": "",
"content": "",
"created_at": "",
"note_id": "",
"updated_at": ""
},
"has_more": false,
"next_cursor": null
}