Microsoft Endpoint Configuration Management Deployments API

openapi: 3.1.0
info:
  title: Microsoft Endpoint Configuration Management Configuration Manager REST API (AdminService) Applications Deployments API
  description: REST API for managing Configuration Manager resources including collections, deployments, applications, and device queries. The administration service is based on the OData v4 protocol and supports both WMI and versioned OData routes. Class names are case-sensitive.
  version: 1.0.0
  contact:
    name: Microsoft Configuration Manager Support
    url: https://learn.microsoft.com/en-us/intune/configmgr/develop/adminservice/overview
  license:
    name: Microsoft API License
    url: https://learn.microsoft.com/en-us/legal/microsoft-apis/terms-of-use
servers:
- url: https://{siteserver}/AdminService
  description: Configuration Manager AdminService endpoint
  variables:
    siteserver:
      default: smsproviderfqdn
      description: Fully qualified domain name of the SMS Provider server hosting the administration service.
security:
- windowsAuth: []
- oauth2: []
tags:
- name: Deployments
  description: View and manage application deployments.
paths:
  /wmi/SMS_ApplicationDeployment:
    get:
      operationId: listDeployments
      summary: Microsoft Endpoint Configuration Management List application deployments
      description: Retrieve all application deployments in Configuration Manager.
      tags:
      - Deployments
      parameters:
      - $ref: '#/components/parameters/top'
      - $ref: '#/components/parameters/filter'
      - $ref: '#/components/parameters/select'
      responses:
        '200':
          description: Successful response returning deployments.
          content:
            application/json:
              schema:
                type: object
                properties:
                  value:
                    type: array
                    items:
                      $ref: '#/components/schemas/SMS_ApplicationDeployment'
components:
  parameters:
    select:
      name: $select
      in: query
      description: Comma-separated list of properties to include.
      schema:
        type: string
    filter:
      name: $filter
      in: query
      description: OData filter expression.
      schema:
        type: string
    top:
      name: $top
      in: query
      description: Number of items to return.
      schema:
        type: integer
  schemas:
    SMS_ApplicationDeployment:
      type: object
      description: Represents an application deployment assignment in Configuration Manager.
      properties:
        AssignmentID:
          type: integer
          description: Unique assignment identifier.
        AssignmentName:
          type: string
          description: Name of the deployment.
        ApplicationName:
          type: string
          description: Name of the deployed application.
        TargetCollectionID:
          type: string
          description: Target collection for the deployment.
        StartTime:
          type: string
          format: date-time
          description: Deployment start time.
        EnforcementDeadline:
          type: string
          format: date-time
          description: Enforcement deadline.
        DesiredConfigType:
          type: integer
          description: Desired configuration type (1=Install, 2=Uninstall).
        OfferTypeID:
          type: integer
          description: Offer type (0=Required, 2=Available).
        Enabled:
          type: boolean
          description: Whether the deployment is enabled.
  securitySchemes:
    windowsAuth:
      type: http
      scheme: negotiate
      description: Windows Integrated Authentication (Kerberos/NTLM).
    oauth2:
      type: oauth2
      description: OAuth 2.0 via Azure AD for cloud management gateway access.
      flows:
        authorizationCode:
          authorizationUrl: https://login.microsoftonline.com/common/oauth2/v2.0/authorize
          tokenUrl: https://login.microsoftonline.com/common/oauth2/v2.0/token
          scopes: {}