Skip to content

MScottBlake/kandji-python-sdk

BranchesTags

Repository files navigation

kandji

Welcome to the Kandji API Documentation

You can find your API URL in Settings > Access. The API URL will follow the below formats.

  • US - https://SubDomain.api.kandji.io

  • EU - https://SubDomain.api.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.

Request Methods

HTTP request methods supported by the Kandji API.

Method Definition
GET The GET method requests a representation of the specified resource.
POST The POST method submits an entity to the specified resource.
PATCH The PATCH method applies partial modifications to a resource.
DELETE The DELETE method deletes the specified resource.

Response codes

Not all response codes apply to every endpoint.

Code Response
200 OK
201 Created
204 No content
Typical response when sending the DELETE method.
400 Bad Request
"Command already running" - The command may already be running in a Pending state waiting on the device.
"Command is not allowed for current device" - The command may not be compatible with the target device.
"JSON parse error - Expecting ',' delimiter: line 3 column 2 (char 65)"
401 Unauthorized
This error can occur if the token is incorrect, was revoked, or the token has expired.
403 Forbidden
The request was understood but cannot be authorized.
404 Not found
Unable to locate the resource in the Kandji tenant.
415 Unsupported Media Type
The request contains a media type which the server or resource does not support.
500 Internal server error
503 Service unavailable
This error can occur if a file upload is still being processed via the custom apps API.

Data structure

The API returns all structured responses in JSON schema format.

Examples

Code examples using the API can be found in the Kandji support GitHub.

This Python package is automatically generated by the OpenAPI Generator project:

Requirements.

Python 3.8+

Installation & Usage

pip install

If the python package is hosted on a repository, you can install directly using:

pip install git+https://github.com/MScottBlake/kandji-python-sdk.git

(you may need to run pip with root permission: sudo pip install git+https://github.com/MScottBlake/kandji-python-sdk.git)

Then import the package:

import kandji

Setuptools

Install via Setuptools.

python setup.py install --user

(or sudo python setup.py install to install the package for all users)

Then import the package:

import kandji

Tests

Execute pytest to run the tests.

Getting Started

Please follow the installation procedure and then run the following:

import kandji
from kandji.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://<sub_domain>.api.kandji.io
# See configuration.py for a list of all supported configuration parameters.
configuration = kandji.Configuration(
    host = "https://<sub_domain>.api.kandji.io"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure Bearer authorization (API Token): bearer
configuration = kandji.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)


# Enter a context with an instance of the API client
with kandji.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = kandji.AutomatedDeviceEnrollmentIntegrationsApi(api_client)
    blueprint_id = 'blueprint_id_example' # str | 
    phone = 'phone_example' # str | 
    email = 'email_example' # str | 
    file = None # bytearray | This is the MDM server token file(.p7m) download from ABM. Once downloaded from ABM, the file can be uploaded via API.

    try:
        # Create ADE integration
        api_response = api_instance.create_ade_integration(blueprint_id, phone, email, file)
        print("The response of AutomatedDeviceEnrollmentIntegrationsApi->create_ade_integration:\n")
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling AutomatedDeviceEnrollmentIntegrationsApi->create_ade_integration: %s\n" % e)

Documentation for API Endpoints

All URIs are relative to https://<sub_domain>.api.kandji.io

Class Method HTTP request Description
AutomatedDeviceEnrollmentIntegrationsApi create_ade_integration POST /api/v1/integrations/apple/ade/ Create ADE integration
AutomatedDeviceEnrollmentIntegrationsApi delete_ade_integration DELETE /api/v1/integrations/apple/ade/{ade_token_id} Delete ADE integration
AutomatedDeviceEnrollmentIntegrationsApi download_ade_public_key GET /api/v1/integrations/apple/ade/public_key/ Download ADE public key
AutomatedDeviceEnrollmentIntegrationsApi get_ade_device GET /api/v1/integrations/apple/ade/devices/{device_id} Get ADE device
AutomatedDeviceEnrollmentIntegrationsApi get_ade_integration GET /api/v1/integrations/apple/ade/{ade_token_id} Get ADE integration
AutomatedDeviceEnrollmentIntegrationsApi list_ade_devices GET /api/v1/integrations/apple/ade/devices List ADE devices
AutomatedDeviceEnrollmentIntegrationsApi list_ade_integrations GET /api/v1/integrations/apple/ade List ADE integrations
AutomatedDeviceEnrollmentIntegrationsApi list_devices_associated_to_ade_token GET /api/v1/integrations/apple/ade/{ade_token_id}/devices List devices associated to ADE token
AutomatedDeviceEnrollmentIntegrationsApi renew_ade_integration POST /api/v1/integrations/apple/ade/{ade_token_id}/renew Renew ADE integration
AutomatedDeviceEnrollmentIntegrationsApi update_ade_device PATCH /api/v1/integrations/apple/ade/devices/{device_id} Update ADE device
AutomatedDeviceEnrollmentIntegrationsApi update_ade_integration PATCH /api/v1/integrations/apple/ade/{ade_token_id} Update ADE integration
BlueprintsApi assign_library_item POST /api/v1/blueprints/{blueprint_id}/assign-library-item Assign Library Item
BlueprintsApi create_blueprint POST /api/v1/blueprints Create Blueprint
BlueprintsApi delete_blueprint DELETE /api/v1/blueprints/{blueprint_id} Delete Blueprint
BlueprintsApi get_blueprint GET /api/v1/blueprints/{blueprint_id} Get Blueprint
BlueprintsApi get_blueprint_templates GET /api/v1/blueprints/templates/ Get Blueprint Templates
BlueprintsApi get_manual_enrollment_profile GET /api/v1/blueprints/{blueprint_id}/ota-enrollment-profile Get Manual Enrollment Profile
BlueprintsApi list_blueprints GET /api/v1/blueprints List Blueprints
BlueprintsApi list_library_items GET /api/v1/blueprints/{blueprint_id}/list-library-items List Library Items
BlueprintsApi remove_library_item POST /api/v1/blueprints/{blueprint_id}/remove-library-item Remove Library Item
BlueprintsApi update_blueprint PATCH /api/v1/blueprints/{blueprint_id} Update Blueprint
DeviceActionsApi clear_passcode POST /api/v1/devices/{device_id}/action/clearpasscode Clear Passcode
DeviceActionsApi delete_device DELETE /api/v1/devices/{device_id} Delete Device
DeviceActionsApi delete_user POST /api/v1/devices/{device_id}/action/deleteuser Delete User
DeviceActionsApi erase_device POST /api/v1/devices/{device_id}/action/erase Erase Device
DeviceActionsApi get_device_commands GET /api/v1/devices/{device_id}/commands Get Device Commands
DeviceActionsApi lock_device POST /api/v1/devices/{device_id}/action/lock Lock Device
DeviceActionsApi reinstall_agent POST /api/v1/devices/{device_id}/action/reinstallagent Reinstall Agent
DeviceActionsApi remote_desktop POST /api/v1/devices/{device_id}/action/remotedesktop Remote Desktop
DeviceActionsApi renew_mdm_profile POST /api/v1/devices/{device_id}/action/renewmdmprofile Renew MDM Profile
DeviceActionsApi restart_device POST /api/v1/devices/{device_id}/action/restart Restart Device
DeviceActionsApi send_blankpush POST /api/v1/devices/{device_id}/action/blankpush Send Blankpush
DeviceActionsApi set_name POST /api/v1/devices/{device_id}/action/setname Set Name
DeviceActionsApi shutdown POST /api/v1/devices/{device_id}/action/shutdown Shutdown
DeviceActionsApi unlock_account POST /api/v1/devices/{device_id}/action/unlockaccount Unlock Account
DeviceActionsApi update_inventory POST /api/v1/devices/{device_id}/action/updateinventory Update Inventory
DeviceInformationApi cancel_lost_mode DELETE /api/v1/devices/{device_id}/details/lostmode Cancel Lost Mode
DeviceInformationApi get_device GET /api/v1/devices/{device_id} Get Device
DeviceInformationApi get_device_activity GET /api/v1/devices/{device_id}/activity Get Device Activity
DeviceInformationApi get_device_apps GET /api/v1/devices/{device_id}/apps Get Device Apps
DeviceInformationApi get_device_details GET /api/v1/devices/{device_id}/details Get Device Details
DeviceInformationApi get_device_library_items GET /api/v1/devices/{device_id}/library-items Get Device Library Items
DeviceInformationApi get_device_lost_mode_details GET /api/v1/devices/{device_id}/details/lostmode Get Device Lost Mode details
DeviceInformationApi get_device_parameters GET /api/v1/devices/{device_id}/parameters Get Device Parameters
DeviceInformationApi get_device_status GET /api/v1/devices/{device_id}/status Get Device Status
DeviceInformationApi list_devices GET /api/v1/devices List Devices
DeviceInformationApi update_device PATCH /api/v1/devices/{device_id} Update Device
DeviceSecretsApi get_activation_lock_bypass_code GET /api/v1/devices/{device_id}/secrets/bypasscode Get Activation Lock Bypass Code
DeviceSecretsApi get_filevault_recovery_key GET /api/v1/devices/{device_id}/secrets/filevaultkey Get FileVault Recovery Key
DeviceSecretsApi get_recovery_lock_password GET /api/v1/devices/{device_id}/secrets/recoverypassword Get Recovery Lock Password
DeviceSecretsApi get_unlock_pin GET /api/v1/devices/{device_id}/secrets/unlockpin Get Unlock Pin
LibraryItemsApi get_library_item_activity GET /api/v1/library/library-items/{library_item_id}/activity Get Library Item Activity
LibraryItemsApi get_library_item_statuses GET /api/v1/library/library-items/{library_item_id}/status Get Library Item Statuses
PrismApi activation_lock GET /api/v1/prism/activation_lock Activation lock
PrismApi application_firewall GET /api/v1/prism/application_firewall Application firewall
PrismApi applications GET /api/v1/prism/apps Applications
PrismApi certificates GET /api/v1/prism/certificates Certificates
PrismApi count GET /api/v1/prism/count Count
PrismApi desktop_and_screensaver GET /api/v1/prism/desktop_and_screensaver Desktop and Screensaver
PrismApi device_information GET /api/v1/prism/device_information Device information
PrismApi filevault GET /api/v1/prism/filevault FileVault
PrismApi gatekeeper_and_xprotect GET /api/v1/prism/gatekeeper_and_xprotect Gatekeeper and XProtect
PrismApi get_category_export GET /api/v1/prism/export/{export_id} Get category export
PrismApi installed_profiles GET /api/v1/prism/installed_profiles Installed profiles
PrismApi kernel_extensions GET /api/v1/prism/kernel_extensions Kernel Extensions
PrismApi launch_agents_and_daemons GET /api/v1/prism/launch_agents_and_daemons Launch Agents and Daemons
PrismApi local_users GET /api/v1/prism/local_users Local users
PrismApi request_category_export POST /api/v1/prism/export Request category export
PrismApi startup_settings GET /api/v1/prism/startup_settings Startup settings
PrismApi system_extensions GET /api/v1/prism/system_extensions System Extensions
PrismApi transparency_database GET /api/v1/prism/transparency_database Transparency database
SettingsApi licensing GET /api/v1/settings/licensing Licensing
TagsApi create_tag POST /api/v1/tags Create Tag
TagsApi delete_tag DELETE /api/v1/tags/{tag_id} Delete Tag
TagsApi get_tags GET /api/v1/tags Get Tags
TagsApi update_tag PATCH /api/v1/tags/{tag_id} Update Tag
ThreatsApi get_threat_details GET /api/v1/threat-details Get Threat Details
UsersApi delete_user DELETE /api/v1/users/{user_id} Delete User
UsersApi get_user GET /api/v1/users/{user_id} Get User
UsersApi list_users GET /api/v1/users List Users
VulnerabilitiesApi get_vulnerability_description GET /api/v1/vulnerability-management/vulnerabilities/{cve_id} Get Vulnerability Description
VulnerabilitiesApi list_affected_applications GET /api/v1/vulnerability-management/vulnerabilities/{cve_id}/applications List Affected Applications
VulnerabilitiesApi list_affected_devices GET /api/v1/vulnerability-management/vulnerabilities/{cve_id}/devices List Affected Devices
VulnerabilitiesApi list_detections GET /api/v1/vulnerability-management/detections List Detections
VulnerabilitiesApi list_vulnerabilities GET /api/v1/vulnerability-management/vulnerabilities List Vulnerabilities

Documentation For Models

Documentation For Authorization

Authentication schemes defined for the API:

bearer

  • Type: Bearer authentication (API Token)

Author

mitchelsblake@gmail.com

About

A Python client for Kandji API

Resources

Readme

License

MIT license
Activity

Stars

0 stars

Watchers

1 watching

Forks

0 forks
Report repository

Releases 39

v2025.02.20.010954 Latest
Feb 20, 2025
+ 38 releases

Sponsor this project

 
Learn more about GitHub Sponsors

Languages