Add a Store or enterprise app to the MDM App Repository

Open in ChatGPT Open in ChatGPT to ask questions about this page
Open in Claude Open in Claude to ask questions about this page
Copy as MarkdownCopy this page as markdown to use with AI assistants
View as Markdown Open this page as markdown in a new tab

Add app to repository

Endpoints

Request URL

https://{server-hostname}:8383/api/v1/mdm/apps

Scope

MDMDeviceMgmt.CREATECopied!

Header

Authorization: d92d4xxxxxxxxxxxxx15f52

Request Parameters

- Request Headers

Content-TypestringMandatory
application/jsonapplication/jsonCopied!
AcceptstringMandatory
application/jsonapplication/jsonCopied!

- Query Parameters

platformstringOptional

Filter results by device platform. Allowed values: 1=iOS, 2=Android, 3=Windows, 4=macOS, 6=tvOS

- Request Body

application/json
JSON Object
Hide Sub-Attributes
app_namestringMandatory

Name of the app to add to the repository

app_typeintegerMandatory

App type: 0 = Free Store App, 1 = Paid Store App, 2 = Enterprise App

app_filelongOptional

File ID of the app package file. Required for enterprise apps (app_type=2). Upload using Upload File

display_imagelongOptional

File ID of the app display image. Upload using Upload File

full_imagelongOptional

File ID of the app full-size image. Upload using Upload File

config_filelongOptional

File ID of the app configuration file. Upload using Upload File

vpp_file_sourcelongOptional

File ID of the VPP file source. Upload using Upload File

app_category_idintegerOptional

Identifier for the app category

supported_devicesintegerOptional

Supported devices: 1 = Smartphone, 2 = Tablet, 3 = Both

release_label_idlongOptional

Release label ID (Stable or Beta channel). Obtain from the Get App Details response

descriptionstringOptional

Custom description of the app

bundle_identifierstringOptional

App bundle identifier

prevent_backupbooleanOptional

Prevent app data backup during device backup. Default: false

Sample Request

Curl
Java
Python
Deluge
PowerShell
Copied!
curl --request POST \
  --url 'https://appdomain/api/v1/mdm/apps?platform=SOME_STRING_VALUE' \
  --header 'Accept: application/json' \
  --header 'Authorization:  d92d4xxxxxxxxxxxxx15f52' \
  --header 'Content-Type: application/json' \
  --data '{"app_name":"Zylker MDM","prevent_backup":false,"app_type":2,"supported_devices":3,"release_label_id":9007199254741076,"description":"The is an enterprise app","bundle_identifier":"com.manageengine.mdm.iosagent","app_category_id":2,"app_file":9007199254741080}'

Sample Request Body

Add an enterprise app with file ID and release label

Copied!
  {
    "app_name": "Zylker MDM",
    "prevent_backup": false,
    "app_type": 2,
    "supported_devices": 3,
    "release_label_id": 9007199254741076,
    "description": "The is an enterprise app",
    "bundle_identifier": "com.manageengine.mdm.iosagent",
    "app_category_id": 2,
    "app_file": 9007199254741080
  }
                
Show full

Add a free store app without app file

Copied!
  {
    "app_name": "Google Chrome",
    "prevent_backup": false,
    "app_type": 0,
    "supported_devices": 1,
    "release_label_id": 9007199254741076,
    "description": "Google Chrome Browser",
    "bundle_identifier": "com.android.chrome",
    "app_category_id": 1,
    "app_file": 0
  }
                
Show full

Response Parameters

- HTTP code 200

Response Body - application/json
JSON Object
Hide Sub-Attributes
app_idlong

Unique identifier for the newly created app

app_namestring

Name of the app

app_categorystring

Category of the app

app_typeinteger

App type: 0 = Free Store App, 1 = Paid Store App, 2 = Enterprise App

bundle_identifierstring

App bundle identifier (e.g., com.manageengine.mdm.iosagent)

versionstring

Version of the app

platform_typeinteger

Platform: 1 = iOS, 2 = Android, 3 = Windows

descriptionstring

Custom description of the app

iconstring

URL link for the app icon image. May be null

store_urlstring

Store URL for the app (iOS only). May be null for enterprise apps

is_app_paidboolean

Whether the app is a paid app

country_codestring

Country code for App Store (iOS only). May be null

store_idstring

Identifier for the App Store (iOS only). May be null

added_timelong

Epoch timestamp (milliseconds) when the app was added

modified_timelong

Epoch timestamp (milliseconds) when the app was last modified

Possible Response Codes

200HTTP code

Sample Response: HTTP 200

Successfully added enterprise app to the repository

Copied!
  {
    "store_id": "9007199254741069",
    "app_type": 2,
    "added_time": 1714630800000,
    "icon": "https://appDomain/mdm-logo.png",
    "description": "The is an enterprise app",
    "version": "1.1.1",
    "store_url": "https://www.zylker.com/app/zylker-mdm/id720111835?mt=8",
    "app_name": "Zylker MDM",
    "country_code": "US",
    "modified_time": 1714717200000,
    "platform_type": 2,
    "is_app_paid": false,
    "bundle_identifier": "com.manageengine.mdm.iosagent",
    "app_category": "Education",
    "app_id": 9007199254741080
  }
                
Show full

Duration: 1 minute | Threshold: 60 | Lock period: 5 minutes

Duration - Time window for the threshold.
Threshold - Number of API calls allowed within the specified duration.
Lock Period - Wait time before consecutive API requests.