---
title: "GET /api/v1/maintenance-actions/version"
method: GET
path: "/api/v1/maintenance-actions/version"
tags: ["MaintenanceActions"]
---

# GET /api/v1/maintenance-actions/version

`GET /api/v1/maintenance-actions/version`

## Request

- Base URL: `https://api.immy.bot` (the document declares no server; this is the origin it was published from)
- URL: `https://api.immy.bot/api/v1/maintenance-actions/version`
- Auth: none declared

## Query parameters

- `softwareType` 'GlobalSoftware' | 'LocalSoftware' | 'WindowsUpdate' | 'Chocolatey' | 'Ninite': The string or integer value may be used. GlobalSoftware = 0, LocalSoftware = 1, WindowsUpdate = 2, Chocolatey = 3, Ninite = 4
- `softwareIdentifier` string
- `version` SemanticVersion
  - `major` integer
  - `minor` integer
  - `patch` integer
  - `releaseLabels` string[], nullable
  - `release` string, nullable
  - `isPrerelease` boolean
  - `hasMetadata` boolean
  - `metadata` string, nullable

## Response `200`

OK

- GetMaintenanceActionResponse[]
  - `id` integer
  - `parentId` integer, nullable
  - `maintenanceSessionId` integer
  - `tenantId` integer, nullable
  - `computerId` integer, nullable
  - `computerName` string, nullable
  - `isComputerOnline` boolean
  - `startTime` string, date-time
  - `endTime` string, date-time
  - `actionType` 'NoAction' | 'Install' | 'Update' | 'Uninstall' | 'Download' | 'Reinstall' | 'Downgrade' | 'Undetermined' | 'TaskEnforce' | 'TaskMonitor' | 'TaskAudit': The string or integer value may be used. NoAction = 0, Install = 1, Update = 2, Uninstall = 3, Download = 4, Reinstall = 5, Downgrade = 6, Undetermined = 7, TaskEnforce = 8, TaskMonitor = 9, TaskAudit = 10
  - `actionTypeName` string, nullable
  - `status` 'NotStarted' | 'Downloading' | 'PerformingAction' | 'DeterminingResult' | 'Complete' | 'WaitingForPrerequisite' | 'DeterminingAction' | 'Skipped' | 'PendingExecution': The string or integer value may be used. NotStarted = 0, Downloading = 1, PerformingAction = 2, DeterminingResult = 3, Complete = 4, WaitingForPrerequisite = 5, DeterminingAction = 6, Skipped = 7, PendingExecution = 8
  - `statusName` string, nullable
  - `assignmentId` integer, nullable
  - `assignmentType` 'Global' | 'Local': The string or integer value may be used. Global = 0, Local = 1
  - `tenantName` string, nullable
  - `maintenanceType` 'GlobalSoftware' | 'LocalSoftware' | 'WindowsUpdate' | 'ChocolateySoftware' | 'NiniteSoftware' | 'LocalMaintenanceTask' | 'GlobalMaintenanceTask' | 'AgentUpdate': The string or integer value may be used. GlobalSoftware = 0, LocalSoftware = 1, WindowsUpdate = 2, ChocolateySoftware = 3, NiniteSoftware = 4, LocalMaintenanceTask = 5, GlobalMaintenanceTask = 6, AgentUpdate = 7
  - `maintenanceIdentifier` string, nullable, required
  - `desiredSoftwareState` 'NewerOrEqualVersion' | 'NotPresent' | 'AnyVersion' | 'ThisVersion' | 'OlderOrEqualVersion' | 'LatestVersion' | 'NoAction' | 'UpdateIfFound': The string or integer value may be used. NewerOrEqualVersion = 0, NotPresent = 1, AnyVersion = 2, ThisVersion = 3, OlderOrEqualVersion = 4, LatestVersion = 5, NoAction = 6, UpdateIfFound = 7
  - `description` string, nullable
  - `postMaintenanceTest` string, nullable
  - `postMaintenanceTestType` integer, nullable
  - `postMaintenanceTestResult` boolean, nullable
  - `postMaintenanceTestResultMessage` string, nullable
  - `maintenanceTypeName` string, nullable
  - `maintenanceDisplayName` string, nullable
  - `detectedVersionString` string, nullable
  - `desiredVersionString` string, nullable
  - `reason` 'SoftwareMissing' | 'UpdateAvailable' | 'UpToDate' | 'NotAssigned' | 'TestFailed' | 'SoftwareDetected' | 'OlderVersionRequired' | 'NoApplicableSoftwareVersion' | 'NoAction' | 'Undetermined' | 'TaskEnforce' | 'TaskAudit' | 'TaskMonitor' | 'TaskNotCompliant' | 'TaskCompliant' | 'DeviceOffline' | 'RepairTriggered': The string or integer value may be used. SoftwareMissing = 0, UpdateAvailable = 1, UpToDate = 2, NotAssigned = 3, TestFailed = 4, SoftwareDetected = 5, OlderVersionRequired = 6, NoApplicableSoftwareVersion = 7, NoAction = 8, Undetermined = 9, TaskEnforce = 10, TaskAudit = 11, TaskMonitor = 12, TaskNotCompliant = 13, TaskCompliant = 14, DeviceOffline = 15, RepairTriggered = 16
  - `result` 'Pending' | 'Success' | 'Failed' | 'Cancelled' | 'Indeterminable' | 'Resolved': The string or integer value may be used. Pending = 0, Success = 1, Failed = 2, Cancelled = 3, Indeterminable = 4, Resolved = 5
  - `resultName` string, nullable
  - `maintenanceTaskMode` 'Enforce' | 'Audit' | 'Monitor' | 'NoAction': The string or integer value may be used. Enforce = 0, Audit = 1, Monitor = 2, NoAction = 3
  - `maintenanceTaskGetResult` string, nullable
  - `createdDateUTC` string, date-time
  - `updatedDateUTC` string, date-time
  - `updatedBy` integer, nullable
  - `createdBy` integer, nullable
  - `softwareType` 'GlobalSoftware' | 'LocalSoftware' | 'WindowsUpdate' | 'Chocolatey' | 'Ninite': The string or integer value may be used. GlobalSoftware = 0, LocalSoftware = 1, WindowsUpdate = 2, Chocolatey = 3, Ninite = 4
  - `maintenanceTaskType` 'Global' | 'Local': The string or integer value may be used. Global = 0, Local = 1
  - `resultReason` 'NoLicenseAvailable' | 'SoftwareNotFound' | 'DetectionActionFailed' | 'TaskNotFound' | 'TaskNotCompliant' | 'TaskCompliant' | 'TaskSetIsMissing' | 'TaskTestIsMissing' | 'TaskGetIsMissing' | 'SoftwareConfigurationTaskMissing' | 'TaskModeIsMissing' | 'DeviceOffline' | 'RebootsSuppressed': The string or integer value may be used. NoLicenseAvailable = 0, SoftwareNotFound = 1, DetectionActionFailed = 2, TaskNotFound = 3, TaskNotCompliant = 4, TaskCompliant = 5, TaskSetIsMissing = 6, TaskTestIsMissing = 7, TaskGetIsMissing = 8, SoftwareConfigurationTaskMissing = 9, TaskModeIsMissing = 10, DeviceOffline = 11, RebootsSuppressed = 12
  - `resultReasonMessage` string, nullable
  - `dependsOnNames` string[], nullable
  - `dependentsNames` string[], nullable
  - `softwareActionIdForConfigurationTask` integer, nullable
  - `softwareProviderType` 'Ninite' | 'Chocolatey' | 'Inherent': The string or integer value may be used. Ninite = 1, Chocolatey = 2, Inherent = 3
  - `policyDescription` string, nullable

---

[API](https://skmtc.dev/immy/apis/immy-bot-api.md) · [All operations](https://skmtc.dev/immy/apis/immy-bot-api/llms.txt) · [OpenAPI document](https://skmtc.dev/immy/apis/immy-bot-api/revisions/559d0e4b39d3?raw)