Kandji

Welcome to the Kandji API Documentation

You can find your API URL in Settings > Access. Typically your API URL will follow the below format.

US Tenants:

https://SubDomain.clients.us-1.kandji.io

UK Tenants:

https://SubDomain.clients.eu.kandji.io

For information on how to obtain an API token, please refer to the following support article.

https://support.kandji.io/api

Rate Limit

The Kandji API currently has an API rate limit of 10,000 requests per hour per customer.

Operations

GET /api/v1/blueprints/

Get All Blueprints

DELETE /api/v1/blueprints/{{id}}/

Delete Blueprint

GET /api/v1/blueprints/{{id}}/

Get Blueprint

PATCH /api/v1/blueprints/{{id}}/

Update Blueprint

POST /api/v1/blueprints/

Create Blueprint

GET /api/v1/blueprints/templates/

Get Blueprint Templates

POST /api/v1/devices/{{device_id}}/action/blankpush/

Send Blankpush

POST /api/v1/devices/{{device_id}}/action/clearpasscode

Clear Passcode

POST /api/v1/devices/{{device_id}}/action/deleteuser

Delete User

POST /api/v1/devices/{{device_id}}/action/erase/

Erase Device

POST /api/v1/devices/{{device_id}}/action/lock

Lock Device

POST /api/v1/devices/{{device_id}}/action/reinstallagent

Reinstall Agent

POST /api/v1/devices/{{device_id}}/action/remotedesktop

Enable Remote Desktop

POST /api/v1/devices/{{device_id}}/action/restart/

Restart Device

POST /api/v1/devices/{{device_id}}/action/setname/

Set Name

POST /api/v1/devices/{{device_id}}/action/shutdown

Shutdown

POST /api/v1/devices/{{device_id}}/action/unlockaccount

Unlock Account

POST /api/v1/devices/{{device_id}}/action/updateinventory

Update Inventory

GET /api/v1/devices/{{device_id}}/activity

Get Device Activity

GET /api/v1/devices/{{device_id}}/apps

Get Device Apps

GET /api/v1/devices/{{device_id}}/commands

Get Device Commands

DELETE /api/v1/devices/{{device_id}}/

Delete Device

GET /api/v1/devices/{device_id}/details

Get Device Details

GET /api/v1/devices/{device_id}/

Get Device

GET /api/v1/devices/{{device_id}}/library-items/

Get Device Library Items

GET /api/v1/devices/{{device_id}}/notes/

Get All Device Notes

DELETE /api/v1/devices/{{device_id}}/notes/noteID/

Delete Device Note

GET /api/v1/devices/{{device_id}}/notes/noteID/

Retrieve Device Note

PATCH /api/v1/devices/{{device_id}}/notes/noteID/

Update Device Note

POST /api/v1/devices/{{device_id}}/notes/

Create Device Note

GET /api/v1/devices/{{device_id}}/parameters/

Get Device Parameters

PATCH /api/v1/devices/{{device_id}}/

Update Device

GET /api/v1/devices/{{device_id}}/secrets/bypasscode/

Get Device Bypass Code

GET /api/v1/devices/{device_id}/secrets/filevaultkey/

Get Device Filevault Key

GET /api/v1/devices/{{device_id}}/secrets/unlockpin/

Get Device Unlock Pin

GET /api/v1/devices/{{device_id}}/status

Get Device Status

GET /api/v1/devices/

Get All Devices