|
1 | 1 | # kandji |
2 | | -<html><head></head><body><h1 id="welcome-to-the-kandji-api-documentation">Welcome to the Kandji API Documentation</h1> |
| 2 | +<html><head></head><body><h1 id="welcome-to-the-iru-endpoint-management-api-documentation">Welcome to the Iru Endpoint Management API Documentation</h1> |
| 3 | +<p><strong>Note:</strong> Kandji is now Iru, but many URLs and notes within this documentation will continue to reference Kandji for some time.</p> |
3 | 4 | <p>You can find your API URL in Settings > Access. The API URL will follow the below formats.</p> |
4 | 5 | <ul> |
5 | 6 | <li><p>US - <code>https://SubDomain.api.kandji.io</code></p> |
|
10 | 11 | <p>For information on how to obtain an API token, please refer to the following support article.</p> |
11 | 12 | <p><a href="https://support.kandji.io/api">https://support.kandji.io/api</a></p> |
12 | 13 | <h4 id="rate-limit">Rate Limit</h4> |
13 | | -<p>The Kandji API currently has an API rate limit of 10,000 requests per hour per customer.</p> |
| 14 | +<p>The Iru Endpoint Management API currently has an API rate limit of 10,000 requests per hour per customer.</p> |
14 | 15 | <h4 id="request-methods">Request Methods</h4> |
15 | | -<p>HTTP request methods supported by the Kandji API.</p> |
| 16 | +<p>HTTP request methods supported by the API.</p> |
16 | 17 | <div class="click-to-expand-wrapper is-table-wrapper"><table> |
17 | 18 | <thead> |
18 | 19 | <tr> |
|
103 | 104 | </tr> |
104 | 105 | <tr> |
105 | 106 | <td></td> |
106 | | -<td>Unable to locate the resource in the Kandji tenant.</td> |
| 107 | +<td>Unable to locate the resource in the Iru tenant.</td> |
107 | 108 | </tr> |
108 | 109 | <tr> |
109 | 110 | <td>415</td> |
|
130 | 131 | </div><h4 id="data-structure">Data structure</h4> |
131 | 132 | <p>The API returns all structured responses in JSON schema format.</p> |
132 | 133 | <h4 id="examples">Examples</h4> |
133 | | -<p>Code examples using the API can be found in the Kandji support <a href="https://github.com/kandji-inc/support/tree/main/api-tools">GitHub</a>.</p> |
| 134 | +<p>Code examples using the API can be found in the Iru Endpoint Management support <a href="https://github.com/kandji-inc/support/tree/main/api-tools">GitHub</a>.</p> |
134 | 135 | </body></html> |
135 | 136 |
|
136 | 137 | This Python package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project: |
@@ -258,6 +259,7 @@ Class | Method | HTTP request | Description |
258 | 259 | *DeviceActionsApi* | [**erase_device**](docs/DeviceActionsApi.md#erase_device) | **POST** /api/v1/devices/{device_id}/action/erase | Erase Device |
259 | 260 | *DeviceActionsApi* | [**get_device_commands**](docs/DeviceActionsApi.md#get_device_commands) | **GET** /api/v1/devices/{device_id}/commands | Get Device Commands |
260 | 261 | *DeviceActionsApi* | [**lock_device**](docs/DeviceActionsApi.md#lock_device) | **POST** /api/v1/devices/{device_id}/action/lock | Lock Device |
| 262 | +*DeviceActionsApi* | [**perform_daily_checkin**](docs/DeviceActionsApi.md#perform_daily_checkin) | **POST** /api/v1/devices/{device_id}/action/dailycheckin | Perform Daily Check-in |
261 | 263 | *DeviceActionsApi* | [**reinstall_agent**](docs/DeviceActionsApi.md#reinstall_agent) | **POST** /api/v1/devices/{device_id}/action/reinstallagent | Reinstall Agent |
262 | 264 | *DeviceActionsApi* | [**remote_desktop**](docs/DeviceActionsApi.md#remote_desktop) | **POST** /api/v1/devices/{device_id}/action/remotedesktop | Remote Desktop |
263 | 265 | *DeviceActionsApi* | [**renew_mdm_profile**](docs/DeviceActionsApi.md#renew_mdm_profile) | **POST** /api/v1/devices/{device_id}/action/renewmdmprofile | Renew MDM Profile |
@@ -344,22 +346,15 @@ Class | Method | HTTP request | Description |
344 | 346 | - [DeviceInformationGetDeviceActivity200Response](docs/DeviceInformationGetDeviceActivity200Response.md) |
345 | 347 | - [DeviceInformationGetDeviceApps200Response](docs/DeviceInformationGetDeviceApps200Response.md) |
346 | 348 | - [DeviceInformationGetDeviceDetails200Response](docs/DeviceInformationGetDeviceDetails200Response.md) |
347 | | - - [DeviceInformationGetDeviceDetails200ResponseActivationLock](docs/DeviceInformationGetDeviceDetails200ResponseActivationLock.md) |
348 | | - - [DeviceInformationGetDeviceDetails200ResponseAppleBusinessManager](docs/DeviceInformationGetDeviceDetails200ResponseAppleBusinessManager.md) |
349 | | - - [DeviceInformationGetDeviceDetails200ResponseAutomatedDeviceEnrollment](docs/DeviceInformationGetDeviceDetails200ResponseAutomatedDeviceEnrollment.md) |
350 | 349 | - [DeviceInformationGetDeviceDetails200ResponseCellular](docs/DeviceInformationGetDeviceDetails200ResponseCellular.md) |
351 | | - - [DeviceInformationGetDeviceDetails200ResponseFilevault](docs/DeviceInformationGetDeviceDetails200ResponseFilevault.md) |
352 | 350 | - [DeviceInformationGetDeviceDetails200ResponseGeneral](docs/DeviceInformationGetDeviceDetails200ResponseGeneral.md) |
353 | | - - [DeviceInformationGetDeviceDetails200ResponseHardwareOverview](docs/DeviceInformationGetDeviceDetails200ResponseHardwareOverview.md) |
354 | | - - [DeviceInformationGetDeviceDetails200ResponseKandjiAgent](docs/DeviceInformationGetDeviceDetails200ResponseKandjiAgent.md) |
355 | | - - [DeviceInformationGetDeviceDetails200ResponseLostMode](docs/DeviceInformationGetDeviceDetails200ResponseLostMode.md) |
356 | | - - [DeviceInformationGetDeviceDetails200ResponseLostModeLastLocation](docs/DeviceInformationGetDeviceDetails200ResponseLostModeLastLocation.md) |
357 | | - - [DeviceInformationGetDeviceDetails200ResponseMdm](docs/DeviceInformationGetDeviceDetails200ResponseMdm.md) |
358 | | - - [DeviceInformationGetDeviceDetails200ResponseRecoveryInformation](docs/DeviceInformationGetDeviceDetails200ResponseRecoveryInformation.md) |
359 | | - - [DeviceInformationGetDeviceDetails200ResponseSecurityInformation](docs/DeviceInformationGetDeviceDetails200ResponseSecurityInformation.md) |
360 | | - - [DeviceInformationGetDeviceDetails200ResponseUsers](docs/DeviceInformationGetDeviceDetails200ResponseUsers.md) |
| 351 | + - [DeviceInformationGetDeviceDetails200ResponseHardware](docs/DeviceInformationGetDeviceDetails200ResponseHardware.md) |
| 352 | + - [DeviceInformationGetDeviceDetails200ResponseManagement](docs/DeviceInformationGetDeviceDetails200ResponseManagement.md) |
| 353 | + - [DeviceInformationGetDeviceDetails200ResponseSecurity](docs/DeviceInformationGetDeviceDetails200ResponseSecurity.md) |
361 | 354 | - [DeviceInformationGetDeviceLibraryItems200Response](docs/DeviceInformationGetDeviceLibraryItems200Response.md) |
362 | 355 | - [DeviceInformationGetDeviceLostModeDetails200Response](docs/DeviceInformationGetDeviceLostModeDetails200Response.md) |
| 356 | + - [DeviceInformationGetDeviceLostModeDetails200ResponseLostMode](docs/DeviceInformationGetDeviceLostModeDetails200ResponseLostMode.md) |
| 357 | + - [DeviceInformationGetDeviceLostModeDetails200ResponseLostModeLastLocation](docs/DeviceInformationGetDeviceLostModeDetails200ResponseLostModeLastLocation.md) |
363 | 358 | - [DeviceInformationGetDeviceParameters200Response](docs/DeviceInformationGetDeviceParameters200Response.md) |
364 | 359 | - [DeviceInformationGetDeviceStatus200Response](docs/DeviceInformationGetDeviceStatus200Response.md) |
365 | 360 | - [DeviceInformationUpdateDevice200Response](docs/DeviceInformationUpdateDevice200Response.md) |
|
0 commit comments