Iru Library API

openapi: 3.2.0
info:
  title: Iru Endpoint Management Library API
  description: "# Welcome to the Iru Endpoint Management API Documentation\n\n**Note:** Kandji is in the process of changing to Iru. Many URLs and notes within this documentation will continue to reference Kandji for some time.\n\nYou can find your API URL in Settings > Access. The API URL will follow the below formats.\n\n- US - `https://SubDomain.api.kandji.io`\n    \n- EU - `https://SubDomain.api.eu.kandji.io`\n    \n\nFor information on how to obtain an API token, please refer to the Iru docs.\n\n[https://docs.iru.com/](https://docs.iru.com/)\n\n#### Rate Limit\n\nThe Iru Endpoint Management API currently has an API rate limit of 10,000 requests per hour per customer.\n\n#### Request Methods\n\nHTTP request methods supported by the API.\n\n| Method | Definition |\n| --- | --- |\n| GET | The `GET` method requests a representation of the specified resource. |\n| POST | The `POST` method submits an entity to the specified resource. |\n| PATCH | The `PATCH` method applies partial modifications to a resource. |\n| DELETE | The `DELETE` method deletes the specified resource. |\n\n#### Response codes\n\nNot all response codes apply to every endpoint.\n\n| Code | Response |\n| --- | --- |\n| 200 | OK |\n| 201 | Created |\n| 204 | No content |\n|  | Typical response when sending the DELETE method. |\n| 400 | Bad Request |\n|  | \"Command already running\" - The command may already be running in a _Pending_ state waiting on the device. |\n|  | \"Command is not allowed for current device\" - The command may not be compatible with the target device. |\n|  | \"JSON parse error - Expecting ',' delimiter: line 3 column 2 (char 65)\" |\n| 401 | Unauthorized |\n|  | This error can occur if the token is incorrect, was revoked, or the token has expired. |\n| 403 | Forbidden |\n|  | The request was understood but cannot be authorized. |\n| 404 | Not found |\n|  | Unable to locate the resource in the Iru tenant. |\n| 415 | Unsupported Media Type |\n|  | The request contains a media type which the server or resource does not support. |\n| 500 | Internal server error |\n| 503 | Service unavailable |\n|  | This error can occur if a file upload is still being processed via the custom apps API. |\n\n#### Data structure\n\nThe API returns all structured responses in JSON schema format.\n\n#### Examples\n\nCode examples using the API can be found in the Iru Endpoint Management support [GitHub](https://github.com/kandji-inc/support/tree/main/api-tools)."
  version: 1.0.0
servers:
- url: https://{subdomain}.api.kandji.io
  description: US Server
  variables:
    subdomain:
      default: your-subdomain
      description: Your Iru Endpoint Management subdomain
- url: https://{subdomain}.api.eu.kandji.io
  description: EU Server
  variables:
    subdomain:
      default: your-subdomain
      description: Your Iru Endpoint Management subdomain
security:
- BearerAuth: []
tags:
- name: Library
paths:
  /api/v1/library/custom-apps:
    get:
      summary: List Custom Apps
      description: This endpoint makes a request to retrieve a list of custom apps from the Iru Endpoint Management library.
      parameters:
      - name: page
        in: query
        required: false
        description: Optional page number. Used when results exceed pagination threshold. A hard upper limit is set at 300 device records returned per request.
        schema:
          type: integer
          minimum: 1
          default: 1
        example: 1
      - name: limit
        in: query
        required: false
        description: Number of results to return per page. A hard upper limit is set at 300 records returned per request.
        schema:
          type: integer
          minimum: 1
          maximum: 300
          default: 300
        example: 300
      - name: offset
        in: query
        required: false
        description: The initial index from which to return the results. Used for offset-based pagination.
        schema:
          type: integer
          minimum: 0
          default: 0
        example: 0
      responses:
        '200':
          description: success
          content:
            application/json:
              schema:
                type: object
                example:
                  count: 2
                  next: null
                  previous: null
                  results:
                  - id: 03fd3564-1e29-433f-8e67-6f987f3d242d
                    name: ms_company_portal
                    file_key: companies/companies/28344fcc-579a-4d42-bcf7-cdbf97585066/library/custom_apps/CompanyPortal_5.2310.5-Installer_0f04055b.pkg
                    install_type: package
                    install_enforcement: install_once
                    audit_script: ''
                    unzip_location: ''
                    active: true
                    restart: false
                    preinstall_script: ''
                    postinstall_script: ''
                    file_url: shortlived S3 URL
                    file_size: 42375997
                    file_updated: '2024-01-20T20:07:48Z'
                    created_at: '2024-01-20T20:07:53.612150Z'
                    updated_at: '2024-02-26T22:31:53.632505Z'
                    show_in_self_service: false
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                    example: Bad Request
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                    example: Unauthorized
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                    example: Not Found
      tags:
      - Library
    post:
      summary: Create Custom App
      description: This request allows you to create a custom app in the Iru Endpoint Management library.
      parameters: []
      requestBody:
        required: true
        content:
          application/x-www-form-urlencoded:
            schema:
              type: object
              properties:
                name:
                  type: string
                  description: The name for this Custom App
                file_key:
                  type: string
                  description: The S3 key from the Upload Custom App endpoint used to upload the custom app file.
                install_type:
                  type: string
                  description: Options are package, zip, image
                install_enforcement:
                  type: string
                  description: Options are install_once, continuously_enforce, no_enforcement
                audit_script:
                  type: string
                  description: Optional audit script for the custom app.
                unzip_location:
                  type: string
                  description: Optional unzip location for the custom app.
                active:
                  type: boolean
                  description: Whether the custom app is active.
                restart:
                  type: boolean
                  description: Whether to restart after installation.
                preinstall_script:
                  type: string
                  description: Optional preinstall script.
                postinstall_script:
                  type: string
                  description: Optional postinstall script.
              required:
              - name
              - file_key
              - install_type
              - install_enforcement
            example:
              name: Custom Apps Test
              file_key: companies/companies/d934a231-e183-4951-b0a0-763e20572c1d/library/custom_apps/test_18cf0dfc.pkg
              install_type: package
              install_enforcement: install_once
              audit_script: ''
              unzip_location: ''
              active: 'true'
              restart: 'false'
              preinstall_script: ''
              postinstall_script: ''
      responses:
        '201':
          description: success
          content:
            application/json:
              schema:
                type: object
                example:
                  id: 58429143-b55c-42d3-a9a3-7c699ddd0ce1
                  name: Custom Apps Test
                  file_key: companies/companies/d934a231-e183-4951-b0a0-763e20572c1d/library/custom_apps/test_18cf0dfc.pkg
                  install_type: package
                  install_enforcement: install_once
                  audit_script: ''
                  unzip_location: ''
                  active: true
                  restart: false
                  preinstall_script: ''
                  postinstall_script: ''
                  file_url: (temporary download link from S3)
                  sha256: 30e14955ebf1352266dc2ff8067e68104607e750abb9d3b36582b8af909fcb58
                  file_size: 1048576
                  file_updated: '2023-10-05T21:25:19Z'
                  created_at: '2023-10-13T17:25:45.868709Z'
                  updated_at: '2023-10-13T17:25:45.868789Z'
                  show_in_self_service: true
                  self_service_category_id: e6f6d5b4-0659-4b37-872c-5471115d453b
                  self_service_recommended: true
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                    example: Bad Request
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                    example: Unauthorized
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                    example: Not Found
      tags:
      - Library
  /api/v1/library/custom-apps/{library_item_id}:
    get:
      summary: Get Custom App
      description: This endpoint retrieves details about a specific custom app from the Kandji library.
      parameters:
      - name: library_item_id
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: success
          content:
            application/json:
              schema:
                type: object
                example:
                  id: 03fd3564-1e29-433f-8e67-6f987f3d242d
                  name: ms_company_portal
                  file_key: companies/companies/28344fcc-579a-4d42-bcf7-cdbf97585066/library/custom_apps/CompanyPortal_5.2310.5-Installer_0f04055b.pkg
                  install_type: package
                  install_enforcement: install_once
                  audit_script: ''
                  unzip_location: ''
                  active: true
                  restart: false
                  preinstall_script: ''
                  postinstall_script: ''
                  file_url: shortlived S3 URL
                  file_size: 42375997
                  file_updated: '2024-01-20T20:07:48Z'
                  created_at: '2024-01-20T20:07:53.612150Z'
                  updated_at: '2024-02-26T22:31:53.632505Z'
                  show_in_self_service: false
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                    example: Bad Request
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                    example: Unauthorized
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                    example: Not Found
      tags:
      - Library
    patch:
      summary: Update Custom App
      description: This request allows you to update a custom app in the Iru Endpoint Management library.
      parameters:
      - name: library_item_id
        in: path
        required: true
        schema:
          type: string
      requestBody:
        required: true
        content:
          application/x-www-form-urlencoded:
            schema:
              type: object
              properties:
                name:
                  type: string
                  description: The name for this Custom App
                install_enforcement:
                  type: string
                  description: Options are install_once, continuously_enforce, no_enforcement
                file_key:
                  type: string
                  description: The S3 key used to upload the file
                install_type:
                  type: string
                  description: Options are package, zip, image
                audit_script:
                  type: string
                  description: Optional audit script for the custom app.
                unzip_location:
                  type: string
                  description: Optional unzip location for the custom app.
                active:
                  type: boolean
                  description: Whether the custom app is active.
                restart:
                  type: boolean
                  description: Whether to restart after installation.
                preinstall_script:
                  type: string
                  description: Optional preinstall script.
                postinstall_script:
                  type: string
                  description: Optional postinstall script.
            example:
              name: Custom App 3
              install_enforcement: install_once
              file_key: companies/companies/d934a231-e183-4951-b0a0-763e20572c1d/library/custom_apps/test_18cf0dfc.pkg
              install_type: package
              audit_script: ''
              unzip_location: ''
              active: 'true'
              restart: 'false'
              preinstall_script: ''
              postinstall_script: ''
      responses:
        '200':
          description: success
          content:
            application/json:
              schema:
                type: object
                example:
                  id: 58429143-b55c-42d3-a9a3-7c699ddd0ce1
                  name: New Custom App Test Name
                  file_key: companies/companies/d934a231-e183-4951-b0a0-763e20572c1d/library/custom_apps/test_18cf0dfc.pkg
                  install_type: package
                  install_enforcement: install_once
                  audit_script: ''
                  unzip_location: ''
                  active: true
                  restart: false
                  preinstall_script: ''
                  postinstall_script: ''
                  file_url: (temporary S3 download URL)
                  sha256: 30e14955ebf1352266dc2ff8067e68104607e750abb9d3b36582b8af909fcb58
                  file_size: 1048576
                  file_updated: '2023-10-05T21:25:19Z'
                  created_at: '2023-10-13T17:25:45.868709Z'
                  updated_at: '2023-10-13T17:28:30.388475Z'
                  show_in_self_service: true
                  self_service_category_id: e6f6d5b4-0659-4b37-872c-5471115d453b
                  self_service_recommended: true
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                    example: Bad Request
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                    example: Unauthorized
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                    example: Not Found
      tags:
      - Library
    delete:
      summary: Delete Custom App
      description: This endpoint sends a request to delete a specific custom app from the Kandji library.
      parameters:
      - name: library_item_id
        in: path
        required: true
        schema:
          type: string
      responses:
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                    example: Bad Request
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                    example: Unauthorized
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                    example: Not Found
      tags:
      - Library
  /api/v1/library/custom-apps/upload:
    post:
      summary: Upload Custom App
      description: This request retrieves the S3 upload details need for uploading the app to Amazon S3.
      parameters: []
      responses:
        '201':
          description: success - create s3 upload
          content:
            application/json:
              schema:
                type: object
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                    example: Bad Request
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                    example: Unauthorized
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                    example: Not Found
      requestBody:
        required: true
        description: JSON payload containing the name of the file being uploaded
        content:
          application/json:
            schema:
              type: object
              properties:
                name:
                  type: string
                  description: Required - name of file being uploaded
                  example: example.pkg
              required:
              - name
            example:
              name: example.pkg
      tags:
      - Library
  /api/v1/library/ipa-apps:
    get:
      summary: List In-House Apps
      description: This endpoint returns a list of In-House App Library Items in your Iru Endpoint Management tenant.
      parameters:
      - name: page
        in: query
        required: false
        description: Optional page number. Used when results exceed pagination threshold. A hard upper limit is set at 300 app records returned per request.
        schema:
          type: integer
          minimum: 1
          default: 1
        example: 1
      - name: limit
        in: query
        required: false
        description: Number of results to return per page. A hard upper limit is set at 300 records returned per request.
        schema:
          type: integer
          minimum: 1
          maximum: 300
          default: 300
        example: 300
      - name: offset
        in: query
        required: false
        description: The initial index from which to return the results. Used for offset-based pagination.
        schema:
          type: integer
          minimum: 0
          default: 0
        example: 0
      responses:
        '200':
          description: success
          content:
            application/json:
              schema:
                type: object
                example:
                  count: 2
                  next: null
                  previous: null
                  results:
                  - id: 13cc4ab7-0380-4d64-b80f-d2c22136e522
                    name: Sammy 1.0.1
                    file_key: tenants/d934a231-e183-4951-b0a0-763e20572c1d/library/ipa_apps/Sammy_f206bbce.ipa
                    active: true
                    icon: tenants/d934a231-e183-4951-b0a0-763e20572c1d/library/ipa_apps/Sammy_f206bbce-Icon.png
                    ipad_icon: tenants/d934a231-e183-4951-b0a0-763e20572c1d/library/ipa_apps/Sammy_f206bbce-IpadIcon.png
                    identifier: io.kandji.sammy
                    app_identifier: io.kandji.sammy
                    app_name: Sammy
                    app_version: 1.0.1
                    supported_device_families:
                    - iPhone
                    - iPad
                    minimum_os_version: '17.5'
                    file_url: https://{sub_domain}.api.kandji.io/tenants/d934a231-e183-4951-b0a0-763e20572c1d/library/ipa_apps/Sammy_f206bbce.ipa?auth=eyJhbGci...ubVg
                    sha256: 862031764fc7368cde2a2267c4891b212b4bbc94aa0534b89be2f6294b8547f0
                    file_size: 2191516
                    file_updated: '2024-10-22T19:45:42Z'
                    created_at: '2024-10-22T19:46:13.080681Z'
                    updated_at: '2024-10-22T19:46:13.080707Z'
                    runs_on_iphone: true
                    runs_on_ipad: true
                    runs_on_tv: false
                    runs_on_mac: false
                    runs_on_ipod: false
                    runs_on_watch: false
                  - id: 26403d86-146c-4b34-ae05-e44f08ee5807
                    name: Sammy 1.0.4
                    file_key: tenants/d934a231-e183-4951-b0a0-763e20572c1d/library/ipa_apps/Sammy_1.0.4_48b8d621.ipa
                    active: true
                    icon: tenants/d934a231-e183-4951-b0a0-763e20572c1d/library/ipa_apps/Sammy_1.0.4_48b8d621-Icon.png
                    ipad_icon: tenants/d934a231-e183-4951-b0a0-763e20572c1d/library/ipa_apps/Sammy_1.0.4_48b8d621-IpadIcon.png
                    identifier: io.kandji.sammy
                    app_identifier: io.kandji.sammy
                    app_name: Sammy
                    app_version: 1.0.4
                    supported_device_families:
                    - iPhone
                    - iPad
                    minimum_os_version: '17.5'
                    file_url: https://{sub_domain}.api.kandji.io/tenants/d934a231-e183-4951-b0a0-763e20572c1d/library/ipa_apps/Sammy_1.0.4_48b8d621.ipa?auth=eyJhbGci...9HaQ
                    sha256: a502ada7d4b6f5eace779889a9149229fa1d385444b008fe752e43d2c8ea1863
                    file_size: 2191525
                    file_updated: '2024-10-30T15:50:37Z'
                    created_at: '2024-10-30T15:50:50.642163Z'
                    updated_at: '2024-10-30T15:50:50.642182Z'
                    runs_on_iphone: true
                    runs_on_ipad: true
                    runs_on_tv: false
                    runs_on_mac: false
                    runs_on_ipod: false
                    runs_on_watch: false
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                    example: Bad Request
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                    example: Unauthorized
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                    example: Not Found
      tags:
      - Library
    post:
      summary: Create In-House App
      description: This endpoint creates a new In-House App Library Item in the Kandji library.
      parameters: []
      responses:
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                    example: Bad Request
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                    example: Unauthorized
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                    example: Not Found
      requestBody:
        required: true
        description: JSON payload containing the in-house app configuration
        content:
          application/json:
            schema:
              type: object
              properties:
                file_key:
                  type: string
                  description: The file key generated from the Upload In-House App to S3 endpoint
                  example: companies/companies/d934a231-e183-4951-b0a0-763e20572c1d/library/ipa_apps/test_app_18cf0dfc.ipa
                name:
                  type: string
                  description: Arbitrary value used for setting the name of the Library Item as it appears in Iru Endpoint Management
                  example: My In-House App
                runs_on_iphone:
                  type: boolean
                  description: Whether the app runs on iPhone
                  example: true
                runs_on_ipad:
                  type: boolean
                  description: Whether the app runs on iPad
                  example: true
                runs_on_tv:
                  type: boolean
                  description: Whether the app runs on Apple TV
                  example: false
                active:
                  type: boolean
                  description: Whether the app is active
                  example: true
              required:
              - file_key
              - name
            example:
              file_key: companies/companies/d934a231-e183-4951-b0a0-763e20572c1d/library/ipa_apps/test_app_18cf0dfc.ipa
              name: My In-House App
              runs_on_iphone: true
              runs_on_ipad: true
              runs_on_tv: false
              active: true
      tags:
      - Library
  /api/v1/library/ipa-apps/{library_item_id}:
    get:
      summary: Get In-House App
      description: This endpoint retrieves information about a specific In-House App Library Item.
      parameters:
      - name: library_item_id
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: success
          content:
            application/json:
              schema:
                type: object
                example:
                  id: 13cc4ab7-0380-4d64-b80f-d2c22136e522
                  name: Sammy 1.0.1
                  file_key: tenants/d934a231-e183-4951-b0a0-763e20572c1d/library/ipa_apps/Sammy_f206bbce.ipa
                  active: true
                  icon: tenants/d934a231-e183-4951-b0a0-763e20572c1d/library/ipa_apps/Sammy_f206bbce-Icon.png
                  ipad_icon: tenants/d934a231-e183-4951-b0a0-763e20572c1d/library/ipa_apps/Sammy_f206bbce-IpadIcon.png
                  identifier: io.kandji.sammy
                  app_identifier: io.kandji.sammy
                  app_name: Sammy
                  app_version: 1.0.1
                  supported_device_families:
                  - iPhone
                  - iPad
                  minimum_os_version: '17.5'
                  file_url: https://{sub_domain}.api.kandji.io/tenants/d934a231-e183-4951-b0a0-763e20572c1d/library/ipa_apps/Sammy_f206bbce.ipa?auth=eyJhbGci...ubVg
                  sha256: 862031764fc7368cde2a2267c4891b212b4bbc94aa0534b89be2f6294b8547f0
                  file_size: 2191516
                  file_updated: '2024-10-22T19:45:42Z'
                  created_at: '2024-10-22T19:46:13.080681Z'
                  updated_at: '2024-10-22T19:46:13.080707Z'
                  runs_on_iphone: true
                  runs_on_ipad: true
                  runs_on_tv: false
                  runs_on_mac: false
                  runs_on_ipod: false
                  runs_on_watch: false
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                    example: Bad Request
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                    example: Unauthorized
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                    example: Not Found
      tags:
      - Library
    patch:
      summary: Update In-House App
      description: This request allows you to update an existing In-House App in the Kandji library.
      parameters:
      - name: library_item_id
        in: path
        required: true
        schema:
          type: string
        description: The unique identifier of the library item
        example: 13cc4ab7-0380-4d64-b80f-d2c22136e522
      responses:
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                    example: Bad Request
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                    example: Unauthorized
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                    example: Not Found
      requestBody:
        required: true
        description: JSON payload containing the in-house app update configuration
        content:
          application/json:
            schema:
              type: object
              properties:
                file_key:
                  type: string
                  description: The file key generated from the Upload In-House App to S3 endpoint
                  example: companies/companies/d934a231-e183-4951-b0a0-763e20572c1d/library/ipa_apps/test_app_18cf0dfc.ipa
                name:
                  type: string
             

# --- truncated at 32 KB (76 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/kandji/refs/heads/main/openapi/kandji-library-api-openapi.yml