Intune

List Applications

get

Retrieves a list of applications

Query parameters

tenantFilterstringOptional

The tenant to filter by

Responses

200

Applications retrieved successfully

application/json

idstringOptional

The application ID

displayNamestringOptional

The display name of the application

publishingStatestringOptional

The publishing state of the application

installCommandLinestringOptional

The install command line

uninstallCommandLinestringOptional

The uninstall command line

400

Bad request

401

Unauthorized

500

Internal server error

get

/ListApps

GET /api/ListApps HTTP/1.1
Accept: */*

[
  {
    "id": "text",
    "displayName": "text",
    "publishingState": "text",
    "installCommandLine": "text",
    "uninstallCommandLine": "text"
  }
]

Assign Application

post

Assigns an application to users or devices

Body

AssignTostring · enumRequired

Who to assign the application to

Possible values:

IDstringRequired

The application ID

customGroupstringOptional

Custom group names (if AssignTo is customGroup)

Responses

200

Application assigned successfully

application/json

ResultsobjectOptional

The results of the operation

400

Bad request

401

Unauthorized

500

Internal server error

post

/ExecAssignApp

POST /api/ExecAssignApp HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 56

{
  "AssignTo": "AllUsers",
  "ID": "text",
  "customGroup": "text"
}

{
  "Results": {}
}

Remove Application

post

Removes an application

Body

IDstringRequired

The application ID

Responses

200

Application removed successfully

application/json

ResultsobjectOptional

The results of the operation

400

Bad request

401

Unauthorized

500

Internal server error

post

/RemoveApp

POST /api/RemoveApp HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 13

{
  "ID": "text"
}

{
  "Results": {}
}

List Application Queue

get

Retrieves a list of applications in the queue

Query parameters

tenantFilterstringOptional

The tenant to filter by

Responses

200

Application queue retrieved successfully

application/json

idstringOptional

The queue item ID

applicationNamestringOptional

The application name

statusstringOptional

The status of the queue item

400

Bad request

401

Unauthorized

500

Internal server error

get

/ListApplicationQueue

GET /api/ListApplicationQueue HTTP/1.1
Accept: */*

[
  {
    "id": "text",
    "applicationName": "text",
    "status": "text"
  }
]

Remove Queued Application

post

Removes an application from the queue

Body

IDstringRequired

The queue item ID

Responses

200

Queued application removed successfully

application/json

ResultsobjectOptional

The results of the operation

400

Bad request

401

Unauthorized

500

Internal server error

post

/RemoveQueuedApp

POST /api/RemoveQueuedApp HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 13

{
  "ID": "text"
}

{
  "Results": {}
}

Execute Application Upload

post

Executes the application upload process

Responses

200

Application upload executed successfully

application/json

ResultsobjectOptional

The results of the operation

400

Bad request

401

Unauthorized

500

Internal server error

post

/ExecAppUpload

POST /api/ExecAppUpload HTTP/1.1
Accept: */*

{
  "Results": {}
}

Add MSP Application

post

Adds an MSP vendor application

Body

displayNamestringRequired

The display name of the application

paramsobjectOptional

Parameters specific to the RMM tool

AssignTostring · enumOptional

Who to assign the application to

Possible values:

customGroupstringOptional

Custom group names (if AssignTo is customGroup)

Responses

200

MSP application added successfully

application/json

ResultsobjectOptional

The results of the operation

400

Bad request

401

Unauthorized

500

Internal server error

post

/AddMSPApp

POST /api/AddMSPApp HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 168

{
  "selectedTenants": [
    {
      "defaultDomainName": "text",
      "customerId": "text"
    }
  ],
  "rmmname": {
    "value": "datto"
  },
  "displayName": "text",
  "params": {},
  "AssignTo": "On",
  "customGroup": "text"
}

{
  "Results": {}
}

Add Store Application

post

Adds a store application

Body

packagenamestringRequired

The package identifier

applicationNamestringRequired

The application name

descriptionstringOptional

The application description

InstallationIntentbooleanOptional

Whether to mark for uninstallation

AssignTostring · enumOptional

Who to assign the application to

Possible values:

customGroupstringOptional

Custom group names (if AssignTo is customGroup)

Responses

200

Store application added successfully

application/json

ResultsobjectOptional

The results of the operation

400

Bad request

401

Unauthorized

500

Internal server error

post

/AddStoreApp

POST /api/AddStoreApp HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 200

{
  "selectedTenants": [
    {
      "defaultDomainName": "text",
      "customerId": "text"
    }
  ],
  "packagename": "text",
  "applicationName": "text",
  "description": "text",
  "InstallationIntent": true,
  "AssignTo": "On",
  "customGroup": "text"
}

{
  "Results": {}
}

Add WinGet Application

post

Adds a WinGet application

Body

packagenamestringRequired

The package identifier

applicationNamestringRequired

The application name

descriptionstringOptional

The application description

InstallationIntentbooleanOptional

Whether to mark for uninstallation

AssignTostring · enumOptional

Who to assign the application to

Possible values:

customGroupstringOptional

Custom group names (if AssignTo is customGroup)

Responses

200

WinGet application added successfully

application/json

ResultsobjectOptional

The results of the operation

400

Bad request

401

Unauthorized

500

Internal server error

post

/AddwinGetApp

POST /api/AddwinGetApp HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 200

{
  "selectedTenants": [
    {
      "defaultDomainName": "text",
      "customerId": "text"
    }
  ],
  "packagename": "text",
  "applicationName": "text",
  "description": "text",
  "InstallationIntent": true,
  "AssignTo": "On",
  "customGroup": "text"
}

{
  "Results": {}
}

Add Chocolatey Application

post

Adds a Chocolatey application

Body

packagenamestringRequired

The package name

applicationNamestringRequired

The application name

descriptionstringOptional

The application description

customRepostringOptional

Custom repository URL

InstallAsSystembooleanOptional

Whether to install as system

DisableRestartbooleanOptional

Whether to disable restart

InstallationIntentbooleanOptional

Whether to mark for uninstallation

AssignTostring · enumOptional

Who to assign the application to

Possible values:

customGroupstringOptional

Custom group names (if AssignTo is customGroup)

Responses

200

Chocolatey application added successfully

application/json

ResultsobjectOptional

The results of the operation

400

Bad request

401

Unauthorized

500

Internal server error

post

/AddChocoApp

POST /api/AddChocoApp HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 265

{
  "selectedTenants": [
    {
      "defaultDomainName": "text",
      "customerId": "text"
    }
  ],
  "packagename": "text",
  "applicationName": "text",
  "description": "text",
  "customRepo": "text",
  "InstallAsSystem": true,
  "DisableRestart": true,
  "InstallationIntent": true,
  "AssignTo": "On",
  "customGroup": "text"
}

{
  "Results": {}
}

Add Office Application

post

Adds a Microsoft Office application

Body

SharedComputerActivationbooleanOptional

Whether to use shared computer activation

archbooleanOptional

Whether to use 64-bit

RemoveVersionsbooleanOptional

Whether to remove other versions

AcceptLicensebooleanOptional

Whether to accept the license

AssignTostring · enumOptional

Who to assign the application to

Possible values:

Responses

200

Office application added successfully

application/json

ResultsobjectOptional

The results of the operation

400

Bad request

401

Unauthorized

500

Internal server error

post

/AddOfficeApp

POST /api/AddOfficeApp HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 276

{
  "selectedTenants": [
    {
      "defaultDomainName": "text",
      "customerId": "text"
    }
  ],
  "excludedApps": [
    {
      "value": "access"
    }
  ],
  "updateChannel": {
    "value": "current"
  },
  "languages": [
    {
      "value": "text"
    }
  ],
  "SharedComputerActivation": true,
  "arch": true,
  "RemoveVersions": true,
  "AcceptLicense": true,
  "AssignTo": "On"
}

{
  "Results": {}
}

List Autopilot Devices

get

Retrieves a list of Autopilot devices

Query parameters

tenantFilterstringOptional

The tenant to filter by

Responses

200

Autopilot devices retrieved successfully

application/json

idstringOptional

The device ID

displayNamestringOptional

The display name of the device

serialNumberstringOptional

The serial number of the device

modelstringOptional

The model of the device

manufacturerstringOptional

The manufacturer of the device

groupTagstringOptional

The group tag of the device

enrollmentStatestringOptional

The enrollment state of the device

400

Bad request

401

Unauthorized

500

Internal server error

get

/ListAPDevices

GET /api/ListAPDevices HTTP/1.1
Accept: */*

[
  {
    "id": "text",
    "displayName": "text",
    "serialNumber": "text",
    "model": "text",
    "manufacturer": "text",
    "groupTag": "text",
    "enrollmentState": "text"
  }
]

Assign Autopilot Device

post

Assigns an Autopilot device to a user

Body

devicestringRequired

The device ID

serialNumberstringRequired

The serial number of the device

userstringRequired

The user principal name

Responses

200

Autopilot device assigned successfully

application/json

ResultsobjectOptional

The results of the operation

400

Bad request

401

Unauthorized

500

Internal server error

post

/ExecAssignAPDevice

POST /api/ExecAssignAPDevice HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 53

{
  "device": "text",
  "serialNumber": "text",
  "user": "text"
}

{
  "Results": {}
}

Remove Autopilot Device

post

Removes an Autopilot device

Body

IDstringRequired

The device ID

Responses

200

Autopilot device removed successfully

application/json

ResultsobjectOptional

The results of the operation

400

Bad request

401

Unauthorized

500

Internal server error

post

/RemoveAPDevice

POST /api/RemoveAPDevice HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 13

{
  "ID": "text"
}

{
  "Results": {}
}

Sync Autopilot Devices

post

Syncs Autopilot devices

Responses

200

Autopilot devices synced successfully

application/json

ResultsobjectOptional

The results of the operation

400

Bad request

401

Unauthorized

500

Internal server error

post

/ExecSyncAPDevices

POST /api/ExecSyncAPDevices HTTP/1.1
Accept: */*

{
  "Results": {}
}

List Autopilot Configurations

get

Retrieves a list of Autopilot configurations

Query parameters

typestring · enumOptional

The type of configuration to retrieve

Possible values:

tenantFilterstringOptional

The tenant to filter by

Responses

200

Autopilot configurations retrieved successfully

application/json

idstringOptional

The configuration ID

displayNamestringOptional

The display name of the configuration

400

Bad request

401

Unauthorized

500

Internal server error

get

/ListAutopilotConfig

GET /api/ListAutopilotConfig HTTP/1.1
Accept: */*

[
  {
    "id": "text",
    "displayName": "text"
  }
]

List Devices

get

Retrieves a list of devices

Query parameters

tenantFilterstringOptional

The tenant to filter by

Responses

200

Devices retrieved successfully

application/json

idstringOptional

The device ID

displayNamestringOptional

The display name of the device

manufacturerstringOptional

The manufacturer of the device

modelstringOptional

The model of the device

osVersionstringOptional

The OS version of the device

lastSyncDateTimestringOptional

The last sync date and time

400

Bad request

401

Unauthorized

500

Internal server error

get

/ListDevices

GET /api/ListDevices HTTP/1.1
Accept: */*

[
  {
    "id": "text",
    "displayName": "text",
    "manufacturer": "text",
    "model": "text",
    "osVersion": "text",
    "lastSyncDateTime": "text"
  }
]

Execute Device Action

post

Executes an action on a device

Body

Actionstring · enumRequired

The action to perform

Possible values:

DeviceIDstringRequired

The device ID

NewDeviceNamestringOptional

The new device name (for Rename action)

Responses

200

Device action executed successfully

application/json

ResultsobjectOptional

The results of the operation

400

Bad request

401

Unauthorized

500

Internal server error

post

/ExecDeviceAction

POST /api/ExecDeviceAction HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 60

{
  "Action": "Reboot",
  "DeviceID": "text",
  "NewDeviceName": "text"
}

{
  "Results": {}
}

Get Local Admin Password

post

Retrieves the local admin password for a device

Body

DeviceIDstringRequired

The device ID

Responses

200

Local admin password retrieved successfully

application/json

ResultsobjectOptional

The results of the operation

400

Bad request

401

Unauthorized

500

Internal server error

post

/ExecGetLocalAdminPassword

POST /api/ExecGetLocalAdminPassword HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 19

{
  "DeviceID": "text"
}

{
  "Results": {}
}

Get Recovery Key

post

Retrieves the recovery key for a device

Body

DeviceIDstringRequired

The device ID

Responses

200

Recovery key retrieved successfully

application/json

ResultsobjectOptional

The results of the operation

400

Bad request

401

Unauthorized

500

Internal server error

post

/ExecGetRecoveryKey

POST /api/ExecGetRecoveryKey HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 19

{
  "DeviceID": "text"
}

{
  "Results": {}
}

List Intune Policies

get

Retrieves a list of Intune policies

Query parameters

typestring · enumOptional

The type of policy to retrieve

Possible values:

tenantFilterstringOptional

The tenant to filter by

Responses

200

Intune policies retrieved successfully

application/json

idstringOptional

The policy ID

displayNamestringOptional

The display name of the policy

400

Bad request

401

Unauthorized

500

Internal server error

get

/ListIntunePolicy

GET /api/ListIntunePolicy HTTP/1.1
Accept: */*

[
  {
    "id": "text",
    "displayName": "text"
  }
]

Add Policy

post

Adds a policy

Body

Responses

200

Policy added successfully

application/json

ResultsobjectOptional

The results of the operation

400

Bad request

401

Unauthorized

500

Internal server error

post

/AddPolicy

POST /api/AddPolicy HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 43

{
  "selectedTenants": [
    {
      "customerId": "text"
    }
  ]
}

{
  "Results": {}
}

Add Intune Template

post

Adds an Intune template

Body

TypestringOptional

The type of template

Responses

200

Intune template added successfully

application/json

ResultsobjectOptional

The results of the operation

400

Bad request

401

Unauthorized

500

Internal server error

post

/AddIntuneTemplate

POST /api/AddIntuneTemplate HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 15

{
  "Type": "text"
}

{
  "Results": {}
}

Assign Policy

post

Assigns a policy

Body

AssignTostring · enumRequired

Who to assign the policy to

Possible values:

IDstringRequired

The policy ID

Responses

200

Policy assigned successfully

application/json

ResultsobjectOptional

The results of the operation

400

Bad request

401

Unauthorized

500

Internal server error

post

/ExecAssignPolicy

POST /api/ExecAssignPolicy HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 35

{
  "AssignTo": "AllUsers",
  "ID": "text"
}

{
  "Results": {}
}

Remove Policy

post

Removes a policy

Body

IDstringRequired

The policy ID

Responses

200

Policy removed successfully

application/json

ResultsobjectOptional

The results of the operation

400

Bad request

401

Unauthorized

500

Internal server error

post

/RemovePolicy

POST /api/RemovePolicy HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 13

{
  "ID": "text"
}

{
  "Results": {}
}

List Intune Templates

get

Retrieves a list of Intune templates

Query parameters

ViewbooleanOptional

Whether to view the templates

tenantFilterstringOptional

The tenant to filter by

Responses

200

Intune templates retrieved successfully

application/json

GUIDstringOptional

The template ID

displayNamestringOptional

The display name of the template

400

Bad request

401

Unauthorized

500

Internal server error

get

/ListIntuneTemplates

GET /api/ListIntuneTemplates HTTP/1.1
Accept: */*

[
  {
    "GUID": "text",
    "displayName": "text"
  }
]

Edit Template

post

Edits a template

Body

GUIDstringOptional

The template ID

Responses

200

Template edited successfully

application/json

ResultsobjectOptional

The results of the operation

400

Bad request

401

Unauthorized

500

Internal server error

post

/ExecEditTemplate

POST /api/ExecEditTemplate HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 15

{
  "GUID": "text"
}

{
  "Results": {}
}

Execute Community Repository

post

Executes a community repository

Body

RepoURLstringOptional

The repository URL

Responses

200

Community repository executed successfully

application/json

ResultsobjectOptional

The results of the operation

400

Bad request

401

Unauthorized

500

Internal server error

post

/ExecCommunityRepo

POST /api/ExecCommunityRepo HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 18

{
  "RepoURL": "text"
}

{
  "Results": {}
}

Remove Intune Template

post

Removes an Intune template

Body

IDstringRequired

The template ID

Responses

200

Intune template removed successfully

application/json

ResultsobjectOptional

The results of the operation

400

Bad request

401

Unauthorized

500

Internal server error

post

/RemoveIntuneTemplate

POST /api/RemoveIntuneTemplate HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 13

{
  "ID": "text"
}

{
  "Results": {}
}

List Intune Scripts

get

Retrieves a list of Intune scripts

Query parameters

tenantFilterstringOptional

The tenant to filter by

Responses

200

Intune scripts retrieved successfully

application/json

idstringOptional

The script ID

displayNamestringOptional

The display name of the script

400

Bad request

401

Unauthorized

500

Internal server error

get

/ListIntuneScript

GET /api/ListIntuneScript HTTP/1.1
Accept: */*

[
  {
    "id": "text",
    "displayName": "text"
  }
]

Remove Intune Script

post

Removes an Intune script

Body

IDstringRequired

The script ID

Responses

200

Intune script removed successfully

application/json

ResultsobjectOptional

The results of the operation

400

Bad request

401

Unauthorized

500

Internal server error

post

/RemoveIntuneScript

POST /api/RemoveIntuneScript HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 13

{
  "ID": "text"
}

{
  "Results": {}
}

List Graph Request

get

Retrieves data from a Graph API request

Query parameters

tenantFilterstringOptional

The tenant to filter by

endpointstringOptional

The Graph API endpoint

Responses

200

Graph request data retrieved successfully

application/json

Resultsobject[]Optional

400

Bad request

401

Unauthorized

500

Internal server error

get

/ListGraphRequest

GET /api/ListGraphRequest HTTP/1.1
Accept: */*

{
  "Results": [
    {}
  ]
}

List Users

get

Retrieves a list of users

Query parameters

tenantFilterstringOptional

The tenant to filter by

Responses

200

Users retrieved successfully

application/json

userPrincipalNamestringOptional

The user principal name

displayNamestringOptional

The display name of the user

400

Bad request

401

Unauthorized

500

Internal server error

get

/listUsers

GET /api/listUsers HTTP/1.1
Accept: */*

[
  {
    "userPrincipalName": "text",
    "displayName": "text"
  }
]

List Apps Repository

post

Searches the apps repository

Body

searchstringRequired

The search query

Responses

200

Apps repository search results retrieved successfully

application/json

400

Bad request

401

Unauthorized

500

Internal server error

post

/ListAppsRepository

POST /api/ListAppsRepository HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 17

{
  "search": "text"
}

{
  "Results": [
    {
      "packagename": "text",
      "applicationName": "text",
      "description": "text"
    }
  ]
}

List Potential Apps

post

Searches for potential apps

Body

searchStringstringRequired

The search query

typestring · enumRequired

The type of apps to search for

Possible values:

Responses

200

Potential apps search results retrieved successfully

application/json

400

Bad request

401

Unauthorized

500

Internal server error

post

/ListPotentialApps

POST /api/ListPotentialApps HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 39

{
  "searchString": "text",
  "type": "WinGet"
}

{
  "data": [
    {
      "packagename": "text",
      "applicationName": "text",
      "description": "text"
    }
  ]
}

List Extensions Configuration

get

Retrieves the configuration for extensions

Responses

200

Extensions configuration retrieved successfully

application/json

400

Bad request

401

Unauthorized

500

Internal server error

get

/ListExtensionsConfig

GET /api/ListExtensionsConfig HTTP/1.1
Accept: */*

{
  "ANY_ADDITIONAL_PROPERTY": {
    "Enabled": true
  }
}

List Community Repositories

get

Retrieves a list of community repositories

Query parameters

tenantFilterstringOptional

The tenant to filter by

Responses

200

Community repositories retrieved successfully

application/json

RepoURLstringOptional

The repository URL

RepoNamestringOptional

The repository name

400

Bad request

401

Unauthorized

500

Internal server error

get

/ListCommunityRepos

GET /api/ListCommunityRepos HTTP/1.1
Accept: */*

[
  {
    "RepoURL": "text",
    "RepoName": "text"
  }
]

PreviousSecurity & Compliance NextTeams & SharePoint

Last updated 7 months ago

Was this helpful?

hashtagList Applications

hashtagAssign Application

hashtagRemove Application

hashtagList Application Queue

hashtagRemove Queued Application

hashtagExecute Application Upload

hashtagAdd MSP Application

hashtagAdd Store Application

hashtagAdd WinGet Application

hashtagAdd Chocolatey Application

hashtagAdd Office Application

hashtagList Autopilot Devices

hashtagAssign Autopilot Device

hashtagRemove Autopilot Device

hashtagSync Autopilot Devices

hashtagList Autopilot Configurations

hashtagList Devices

hashtagExecute Device Action

hashtagGet Local Admin Password

hashtagGet Recovery Key

hashtagList Intune Policies

hashtagAdd Policy

hashtagAdd Intune Template

hashtagAssign Policy

hashtagRemove Policy

hashtagList Intune Templates

hashtagEdit Template

hashtagExecute Community Repository

hashtagRemove Intune Template

hashtagList Intune Scripts

hashtagRemove Intune Script

hashtagList Graph Request

hashtagList Users

hashtagList Apps Repository

hashtagList Potential Apps

hashtagList Extensions Configuration

hashtagList Community Repositories

List Applications

Assign Application

Remove Application

List Application Queue

Remove Queued Application

Execute Application Upload

Add MSP Application

Add Store Application

Add WinGet Application

Add Chocolatey Application

Add Office Application

List Autopilot Devices

Assign Autopilot Device

Remove Autopilot Device

Sync Autopilot Devices

List Autopilot Configurations

List Devices

Execute Device Action

Get Local Admin Password

Get Recovery Key

List Intune Policies

Add Policy

Add Intune Template

Assign Policy

Remove Policy

List Intune Templates

Edit Template

Execute Community Repository

Remove Intune Template

List Intune Scripts

Remove Intune Script

List Graph Request

List Users

List Apps Repository

List Potential Apps

List Extensions Configuration

List Community Repositories