All URIs are relative to **
| Method | HTTP request | Description |
|---|---|---|
| createInhouseApp | POST /api/v1/library/ipa-apps | Create In-House App |
| deleteInhouseApp | DELETE /api/v1/library/ipa-apps/{library_item_id} | Delete In-House App |
| getInhouseApp | GET /api/v1/library/ipa-apps/{library_item_id} | Get In-House App |
| listInhouseApps | GET /api/v1/library/ipa-apps | List In-House Apps |
| updateInhouseApp | PATCH /api/v1/library/ipa-apps/{library_item_id} | Update In-House App |
| uploadInhouseApp | POST /api/v1/library/ipa-apps/upload | Upload In-House App |
| uploadInhouseAppStatus | GET /api/v1/library/ipa-apps/upload/{pending_upload_id}/status | Upload In-House App Status |
Create In-House App
After uploading the .ipa app file to S3, this request allows you to create the In-House App in the Kandji library.
You must have already generated a file_key via Create In-House App endpoint and uploaded the file to S3 using a request similar to the Upload In-House App to S3 example.
The name key can be an arbitrary value used for setting the name of the Library Item as it appears in Kandji
kandji createInhouseApp Content-Type:value| Name | Type | Description | Notes |
|---|---|---|---|
| contentType | string | [default to null] | |
| body | string | [optional] |
(empty response body)
- Content-Type: application/json
- Accept: Not Applicable
[Back to top] [Back to API list] [Back to Model list] [Back to README]
Delete In-House App
NOTICE: This is permanent so be careful.
This endpoint sends a request to delete a specific In-House App Library Item from Kandji.
library_item_id (path parameter): The unique identifier of the Library Item.
kandji deleteInhouseApp library_item_id=value| Name | Type | Description | Notes |
|---|---|---|---|
| libraryItemId | string | [default to null] |
(empty response body)
- Content-Type: Not Applicable
- Accept: Not Applicable
[Back to top] [Back to API list] [Back to Model list] [Back to README]
Get In-House App
This endpoint retrieves details about a specific In-House App from the Kandji Library.
library_item_id (path parameter): The unique identifier of the Library Item.
kandji getInhouseApp library_item_id=value| Name | Type | Description | Notes |
|---|---|---|---|
| libraryItemId | string | [default to null] |
map
- Content-Type: Not Applicable
- Accept: application/json; charset=utf-8
[Back to top] [Back to API list] [Back to Model list] [Back to README]
List In-House Apps
This endpoint makes a request to retrieve a list of In-House Apps from the Kandji library.
kandji listInhouseApps page=value| Name | Type | Description | Notes |
|---|---|---|---|
| page | string | Optional page number. Used when results exceed pagination threshold. A hard upper limit is set at 300 app records returned per request. |
[optional] [default to null] |
map
- Content-Type: Not Applicable
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
Update In-House App
This request allows you to update an existing In-house App in the Kandji library.
Must have already generated a file_key via Create In-House App endpoint and uploaded the file to S3 using a request similar to the Upload In-House App to S3 example.
library_item_id (path parameter): The unique identifier of the library item.
kandji updateInhouseApp library_item_id=value Content-Type:value| Name | Type | Description | Notes |
|---|---|---|---|
| libraryItemId | string | [default to null] | |
| contentType | string | [default to null] | |
| body | string | [optional] |
(empty response body)
- Content-Type: text/plain
- Accept: Not Applicable
[Back to top] [Back to API list] [Back to Model list] [Back to README]
Upload In-House App
This request retrieves the S3 upload details needed for uploading the in-house app .ipa file to Amazon S3.
Creates a pre-signed post_url to upload a new In-house App to S3.
The provided filename will be used to calculate a unique file_key in S3.
A separate request will have to be made to the Upload In-House App to S3 endpoint to upload the file to S3 directly using the post_url and post_data from the Upload In-House App response.
The returned id value can be used to check the upload status in the Upload In-House App Status endpoint after calling the Upload In-House App to S3 endpoint.
kandji uploadInhouseApp Content-Type:value| Name | Type | Description | Notes |
|---|---|---|---|
| contentType | string | [default to null] | |
| body | string | [optional] |
map
- Content-Type: application/json
- Accept: application/json; charset=utf-8
[Back to top] [Back to API list] [Back to Model list] [Back to README]
Upload In-House App Status
This endpoint retrieves current upload status of an In-House App .ipa file to Amazon S3 from the Upload In-House App to S3 endpoint
The app .ipa file has successfully uploaded and is ready for the Create In-House App endpoint when the status returned is VALIDATED
If the status returned is UPLOADING or VALIDATING, the upload is still being processed. Retry again after 1 second.
If the status returned is UPLOAD_FAILED or VALIDATE_FAILED then re-attempt the Upload In-House App to S3 endpoint.
pending_upload_id (path parameter): This should be the id from the Upload to In-House App API response
kandji uploadInhouseAppStatus pending_upload_id=value| Name | Type | Description | Notes |
|---|---|---|---|
| pendingUploadId | string | [default to null] |
map
- Content-Type: Not Applicable
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]