Microsoft Endpoint Configuration Management Software Updates API

openapi: 3.1.0
info:
  title: Microsoft Endpoint Configuration Management Configuration Manager REST API (AdminService) Applications Software Updates 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: Software Updates
  description: Query software update information.
paths:
  /wmi/SMS_SoftwareUpdate:
    get:
      operationId: listSoftwareUpdates
      summary: Microsoft Endpoint Configuration Management List software updates
      description: Retrieve all software updates known to Configuration Manager.
      tags:
      - Software Updates
      parameters:
      - $ref: '#/components/parameters/top'
      - $ref: '#/components/parameters/filter'
      - $ref: '#/components/parameters/select'
      responses:
        '200':
          description: Successful response returning software updates.
          content:
            application/json:
              schema:
                type: object
                properties:
                  value:
                    type: array
                    items:
                      $ref: '#/components/schemas/SMS_SoftwareUpdate'
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_SoftwareUpdate:
      type: object
      description: Represents a software update known to Configuration Manager.
      properties:
        CI_ID:
          type: integer
          description: Configuration item ID.
        ArticleID:
          type: string
          description: Knowledge base article ID.
        BulletinID:
          type: string
          description: Security bulletin ID.
        LocalizedDisplayName:
          type: string
          description: Display name of the update.
        LocalizedDescription:
          type: string
          description: Description of the update.
        DatePosted:
          type: string
          format: date-time
          description: Date the update was posted.
        DateRevised:
          type: string
          format: date-time
          description: Date the update was revised.
        IsDeployed:
          type: boolean
          description: Whether the update is deployed.
        IsSuperseded:
          type: boolean
          description: Whether the update is superseded.
        NumMissing:
          type: integer
          description: Number of systems missing this update.
        NumPresent:
          type: integer
          description: Number of systems with this update installed.
        SeverityName:
          type: string
          description: Severity rating.
  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: {}