---
title: "GET /api/v1/maintenance-sessions/{sessionId}"
method: GET
path: "/api/v1/maintenance-sessions/{sessionId}"
tags: ["MaintenanceSessions"]
---

# GET /api/v1/maintenance-sessions/{sessionId}

`GET /api/v1/maintenance-sessions/{sessionId}`

## 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-sessions/{sessionId}`
- Auth: none declared

## Path parameters

- `sessionId` integer, required

## Query parameters

- `includeActions` boolean
- `includeStages` boolean
- `includeActionActivities` boolean

## Response `200`

OK

- GetMaintenanceSessionResponse
  - `id` integer
  - `jobId` string, nullable
  - `computerId` integer, nullable
  - `tenantId` integer, nullable
  - `personId` integer, nullable
  - `scheduledId` integer, nullable
  - `sessionStatus` 'Passed' | 'Running' | 'Failed' | 'Created' | 'Cancelled' | 'Postponed' | 'Pending' | 'PartialPassed' | 'PendingConnectivity' | 'Missed' | 'MaxTrackedDevicesPerMonthExceeded' | 'PendingPreflight' | 'PendingEphemeralAgentConnection' | 'MaintenanceForTrackableDevicesNotAllowed': The string or integer value may be used. Passed = 0, Running = 1, Failed = 2, Created = 3, Cancelled = 4, Postponed = 5, Pending = 6, PartialPassed = 7, PendingConnectivity = 8, Missed = 9, MaxTrackedDevicesPerMonthExceeded = 10, PendingPreflight = 11, PendingEphemeralAgentConnection = 12, MaintenanceForTrackableDevicesNotAllowed = 13
  - `onboarding` boolean
  - `createdDateUTC` string, date-time
  - `updatedDateUTC` string, date-time
  - `updatedById` integer, nullable
  - `createdById` integer, nullable
  - `createdBy` string, nullable
  - `fullMaintenance` boolean
  - `computerName` string, nullable
  - `tenantName` string, nullable
  - `duration` string, date-span, nullable
  - `onboardingStageStatus` 'Passed' | 'Running' | 'Failed' | 'Created' | 'Cancelled' | 'Postponed' | 'Pending' | 'PartialPassed' | 'PendingConnectivity' | 'Missed' | 'MaxTrackedDevicesPerMonthExceeded' | 'PendingPreflight' | 'PendingEphemeralAgentConnection' | 'MaintenanceForTrackableDevicesNotAllowed': The string or integer value may be used. Passed = 0, Running = 1, Failed = 2, Created = 3, Cancelled = 4, Postponed = 5, Pending = 6, PartialPassed = 7, PendingConnectivity = 8, Missed = 9, MaxTrackedDevicesPerMonthExceeded = 10, PendingPreflight = 11, PendingEphemeralAgentConnection = 12, MaintenanceForTrackableDevicesNotAllowed = 13
  - `detectionStageStatus` 'Passed' | 'Running' | 'Failed' | 'Created' | 'Cancelled' | 'Postponed' | 'Pending' | 'PartialPassed' | 'PendingConnectivity' | 'Missed' | 'MaxTrackedDevicesPerMonthExceeded' | 'PendingPreflight' | 'PendingEphemeralAgentConnection' | 'MaintenanceForTrackableDevicesNotAllowed': The string or integer value may be used. Passed = 0, Running = 1, Failed = 2, Created = 3, Cancelled = 4, Postponed = 5, Pending = 6, PartialPassed = 7, PendingConnectivity = 8, Missed = 9, MaxTrackedDevicesPerMonthExceeded = 10, PendingPreflight = 11, PendingEphemeralAgentConnection = 12, MaintenanceForTrackableDevicesNotAllowed = 13
  - `executionStageStatus` 'Passed' | 'Running' | 'Failed' | 'Created' | 'Cancelled' | 'Postponed' | 'Pending' | 'PartialPassed' | 'PendingConnectivity' | 'Missed' | 'MaxTrackedDevicesPerMonthExceeded' | 'PendingPreflight' | 'PendingEphemeralAgentConnection' | 'MaintenanceForTrackableDevicesNotAllowed': The string or integer value may be used. Passed = 0, Running = 1, Failed = 2, Created = 3, Cancelled = 4, Postponed = 5, Pending = 6, PartialPassed = 7, PendingConnectivity = 8, Missed = 9, MaxTrackedDevicesPerMonthExceeded = 10, PendingPreflight = 11, PendingEphemeralAgentConnection = 12, MaintenanceForTrackableDevicesNotAllowed = 13
  - `agentUpdatesStageStatus` 'Passed' | 'Running' | 'Failed' | 'Created' | 'Cancelled' | 'Postponed' | 'Pending' | 'PartialPassed' | 'PendingConnectivity' | 'Missed' | 'MaxTrackedDevicesPerMonthExceeded' | 'PendingPreflight' | 'PendingEphemeralAgentConnection' | 'MaintenanceForTrackableDevicesNotAllowed': The string or integer value may be used. Passed = 0, Running = 1, Failed = 2, Created = 3, Cancelled = 4, Postponed = 5, Pending = 6, PartialPassed = 7, PendingConnectivity = 8, Missed = 9, MaxTrackedDevicesPerMonthExceeded = 10, PendingPreflight = 11, PendingEphemeralAgentConnection = 12, MaintenanceForTrackableDevicesNotAllowed = 13
  - `resolutionStageStatus` 'Passed' | 'Running' | 'Failed' | 'Created' | 'Cancelled' | 'Postponed' | 'Pending' | 'PartialPassed' | 'PendingConnectivity' | 'Missed' | 'MaxTrackedDevicesPerMonthExceeded' | 'PendingPreflight' | 'PendingEphemeralAgentConnection' | 'MaintenanceForTrackableDevicesNotAllowed': The string or integer value may be used. Passed = 0, Running = 1, Failed = 2, Created = 3, Cancelled = 4, Postponed = 5, Pending = 6, PartialPassed = 7, PendingConnectivity = 8, Missed = 9, MaxTrackedDevicesPerMonthExceeded = 10, PendingPreflight = 11, PendingEphemeralAgentConnection = 12, MaintenanceForTrackableDevicesNotAllowed = 13
  - `inventoryStageStatus` 'Passed' | 'Running' | 'Failed' | 'Created' | 'Cancelled' | 'Postponed' | 'Pending' | 'PartialPassed' | 'PendingConnectivity' | 'Missed' | 'MaxTrackedDevicesPerMonthExceeded' | 'PendingPreflight' | 'PendingEphemeralAgentConnection' | 'MaintenanceForTrackableDevicesNotAllowed': The string or integer value may be used. Passed = 0, Running = 1, Failed = 2, Created = 3, Cancelled = 4, Postponed = 5, Pending = 6, PartialPassed = 7, PendingConnectivity = 8, Missed = 9, MaxTrackedDevicesPerMonthExceeded = 10, PendingPreflight = 11, PendingEphemeralAgentConnection = 12, MaintenanceForTrackableDevicesNotAllowed = 13
  - `sessionJobArgs` SessionJobArgs
    - `sessionGroupId` string, uuid, nullable
    - `manuallyTriggeredByUserId` integer, nullable
    - `manuallyResumedByPersonId` integer, nullable
    - `manuallyResumed` boolean
    - `scheduledId` integer, nullable
    - `computerId` integer, nullable
    - `tenantId` integer, nullable
    - `personId` integer, nullable
    - `installWindowsUpdates` boolean
    - `cacheOnly` boolean
    - `rebootPreference` 'Normal' | 'Suppress' | 'Prompt' | 'Force': The string or integer value may be used. Normal = 0, Suppress = 1, Prompt = 2, Force = -1
    - `promptTimeoutAction` 'Reboot' | 'Suppress' | 'FailSession': The string or integer value may be used. Reboot = 0, Suppress = 1, FailSession = 2
    - `autoConsentToReboots` boolean
    - `promptTimeoutMinutes` integer
    - `propagateToChildTenants` boolean
    - `allowAccessToParentTenant` boolean
    - `maintenanceSchedulingConfiguration` MaintenanceSchedulingConfiguration
      - `time` string, nullable
      - `maintenanceTime` string, nullable
      - `timeZoneInfoId` string, nullable
      - `offlineBehavior` 'Skip' | 'ApplyOnConnect': The string or integer value may be used. Skip = 1, ApplyOnConnect = 2
      - `useComputersTimezoneForExecution` boolean
      - `scheduleExecutionAfterActiveHours` boolean
    - `maintenanceOnboardingConfiguration` MaintenanceOnboardingConfiguration
      - `onboardingOnlyParameterValueOverrides` object, nullable
      - `onboardingOnlyMaintenanceTaskParameterValueOverrides` MaintenanceTaskParameterValueDetails[], nullable
        - `id` integer
        - `value` string, nullable
        - `deploymentId` integer
        - `maintenanceTaskType` 'Global' | 'Local': The string or integer value may be used. Global = 0, Local = 1
        - `maintenanceTaskId` integer
        - `maintenanceTaskParameterId` integer
        - `mediaId` integer, nullable
        - `mediaDatabaseType` 'Global' | 'Local': The string or integer value may be used. Global = 0, Local = 1
        - `allowOverrideFromComputerOnboarding` boolean
        - `parameterName` string, nullable
        - `parameterType` 'Number' | 'Text' | 'Boolean' | 'Select' | 'Password' | 'File' | 'Uri' | 'KeyValuePair': The string or integer value may be used. Number = 0, Text = 1, Boolean = 2, Select = 3, Password = 4, File = 5, Uri = 6, KeyValuePair = 7
      - `automaticOnboarding` boolean
    - `maintenanceEmailConfiguration` MaintenanceEmailConfiguration
      - `sendDetectionEmail` boolean
      - `sendDetectionEmailWhenAllActionsAreCompliant` boolean
      - `sendFollowUpEmail` boolean
      - `sendFollowUpOnlyIfActionNeeded` boolean
      - `showRunNowButton` boolean
      - `showPostponeButton` boolean
      - `showMaintenanceActions` boolean
    - `maintenanceAgentUpdatesConfiguration` MaintenanceAgentUpdatesConfiguration
      - `providerLinkId` integer, nullable
    - `maintenanceItem` MaintenanceItem
      - `maintenanceIdentifier` 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
      - `providerLinkIdForMaintenanceItem` integer, nullable
    - `deploymentId` integer, nullable
    - `deploymentType` 'Global' | 'Local': The string or integer value may be used. Global = 0, Local = 1
    - `cacheGroupId` string, uuid, nullable
    - `rerunningAction` boolean
    - `actionIdToRerun` integer, nullable
    - `terminalId` string, uuid, nullable
    - `detectionOnly` boolean
    - `runInventoryInDetection` boolean
    - `resolutionOnly` boolean
    - `inventoryOnly` boolean
    - `repair` boolean
    - `offlineBehavior` 'Skip' | 'ApplyOnConnect': The string or integer value may be used. Skip = 1, ApplyOnConnect = 2
    - `suppressRebootsDuringBusinessHours` boolean
    - `appliedOnConnect` boolean
    - `useWinningDeployment` boolean
    - `hasSessionFeatureBeenTracked` boolean
    - `rerunFromScheduleId` integer, nullable
    - `enqueuedSessionType` 'HangfireAdhoc' | 'HangfireOnboarding' | 'HangfireScheduled' | 'HangfireConnectivityTriggered' | 'NotHangfire': The string or integer value may be used. HangfireAdhoc = 1, HangfireOnboarding = 2, HangfireScheduled = 3, HangfireConnectivityTriggered = 4, NotHangfire = 5
  - `scheduledExecutionDate` string, date-time, nullable
  - `maintenanceActions` GetMaintenanceActionResponse[], nullable
    - `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
  - `stages` GetMaintenanceSessionStageResponse[], nullable
    - `id` integer
    - `maintenanceSessionId` integer
    - `stageStatus` 'Passed' | 'Running' | 'Failed' | 'Created' | 'Cancelled' | 'Postponed' | 'Pending' | 'PartialPassed' | 'PendingConnectivity' | 'Missed' | 'MaxTrackedDevicesPerMonthExceeded' | 'PendingPreflight' | 'PendingEphemeralAgentConnection' | 'MaintenanceForTrackableDevicesNotAllowed': The string or integer value may be used. Passed = 0, Running = 1, Failed = 2, Created = 3, Cancelled = 4, Postponed = 5, Pending = 6, PartialPassed = 7, PendingConnectivity = 8, Missed = 9, MaxTrackedDevicesPerMonthExceeded = 10, PendingPreflight = 11, PendingEphemeralAgentConnection = 12, MaintenanceForTrackableDevicesNotAllowed = 13
    - `type` 'Onboarding' | 'Detection' | 'Execution' | 'AgentUpdates' | 'Resolution' | 'Inventory': The string or integer value may be used. Onboarding = 0, Detection = 1, Execution = 2, AgentUpdates = 3, Resolution = 4, Inventory = 5
    - `jobId` string, nullable
    - `updatedBy` integer, nullable
    - `createdBy` integer, nullable
    - `updatedDateUTC` string, date-time
    - `createdDateUTC` string, date-time
    - `maintenanceSession` GetMaintenanceSessionResponse (recursive)
  - `activities` MaintenanceActionActivityResponse[], nullable
    - `id` integer
    - `maintenanceSessionId` integer
    - `maintenanceActionId` integer
    - `activity` string, nullable
    - `currentOperation` string, nullable
    - `activityId` string, nullable
    - `parentId` string, nullable
    - `percentComplete` integer, nullable
    - `secondsRemaining` integer, nullable
    - `sourceId` string, nullable
    - `status` string, nullable
    - `completed` boolean, nullable
    - `dateUtc` string, date-time
    - `scriptName` string, nullable
  - `logs` GetSessionLogResponse[], nullable
    - `id` integer
    - `message` string, nullable
    - `maintenanceSessionId` integer
    - `maintenanceSessionStageId` integer, nullable
    - `maintenanceActionId` integer, nullable
    - `time` string, date-time
    - `isPrimary` boolean
    - `progressCorrelationId` string, uuid, nullable
    - `sessionPhaseId` integer, nullable
    - `maintenanceActionStatus` '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
    - `scriptId` integer, nullable
    - `script` string, nullable
    - `scriptOutput` string, nullable
    - `scriptType` 'Global' | 'Local': The string or integer value may be used. Global = 0, Local = 1
    - `scriptLanguage` 'CommandLine' | 'PowerShell': The string or integer value may be used. CommandLine = 1, PowerShell = 2
    - `scriptParameters` object, nullable
    - `paramBlockParameters` object, nullable
    - `updatedTime` string, date-time, nullable
    - `sessionLogType` 'Generic' | 'Error' | 'Command' | 'CommandResult' | 'Progress': The string or integer value may be used. Generic = 0, Error = 1, Command = 2, CommandResult = 3, Progress = 4
    - `progressPercentComplete` number, double, nullable
    - `progressActivity` string, nullable
    - `progressStatus` string, nullable
    - `progressSecondsRemaining` number, double, nullable
    - `progressCurrentOperation` string, nullable
    - `progressCompleted` boolean
    - `maintenanceSession` GetMaintenanceSessionResponse (recursive)
    - `maintenanceSessionStage` GetMaintenanceSessionStageResponse
      - `id` integer
      - `maintenanceSessionId` integer
      - `stageStatus` 'Passed' | 'Running' | 'Failed' | 'Created' | 'Cancelled' | 'Postponed' | 'Pending' | 'PartialPassed' | 'PendingConnectivity' | 'Missed' | 'MaxTrackedDevicesPerMonthExceeded' | 'PendingPreflight' | 'PendingEphemeralAgentConnection' | 'MaintenanceForTrackableDevicesNotAllowed': The string or integer value may be used. Passed = 0, Running = 1, Failed = 2, Created = 3, Cancelled = 4, Postponed = 5, Pending = 6, PartialPassed = 7, PendingConnectivity = 8, Missed = 9, MaxTrackedDevicesPerMonthExceeded = 10, PendingPreflight = 11, PendingEphemeralAgentConnection = 12, MaintenanceForTrackableDevicesNotAllowed = 13
      - `type` 'Onboarding' | 'Detection' | 'Execution' | 'AgentUpdates' | 'Resolution' | 'Inventory': The string or integer value may be used. Onboarding = 0, Detection = 1, Execution = 2, AgentUpdates = 3, Resolution = 4, Inventory = 5
      - `jobId` string, nullable
      - `updatedBy` integer, nullable
      - `createdBy` integer, nullable
      - `updatedDateUTC` string, date-time
      - `createdDateUTC` string, date-time
      - `maintenanceSession` GetMaintenanceSessionResponse (recursive)
    - `maintenanceAction` 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
  - `computer` GetComputerResponse
    - `id` integer
    - `deviceId` string, uuid
    - `tenantId` integer
    - `computerName` string, nullable
    - `primaryPersonId` integer, nullable
    - `onboardingStatus` 'NeedsOnboarding' | 'Onboarding' | 'Onboarded': The string or integer value may be used. NeedsOnboarding = 0, Onboarding = 1, Onboarded = 2
    - `isOnline` boolean
    - `isDomainController` boolean, nullable
    - `isPortable` boolean, nullable
    - `isServer` boolean, nullable
    - `isDesktop` boolean, nullable
    - `tenantName` string, nullable
    - `inventory` unknown
    - `isMissingSomeRequiredInventoryResults` boolean, nullable
    - `detectionOutdated` boolean
    - `isSandbox` boolean
    - `excludeFromMaintenance` boolean
    - `devLabVmClaimExpirationDateUtc` string, date-time, nullable
    - `isDevLab` boolean
    - `devLabVmUnclaimed` boolean
    - `ephemeralAgentConnected` boolean
    - `licensed` boolean
    - `notes` string, nullable
    - `excludedFromUserAffinity` boolean
    - `sessions` GetMaintenanceSessionResponse[], nullable
    - `additionalPersons` GetPersonResponse[], nullable
      - `id` integer
      - `tenantId` integer
      - `azurePrincipalId` string, nullable
      - `firstName` string, nullable
      - `lastName` string, nullable
      - `emailAddress` string, nullable
      - `displayName` string, nullable
      - `updatedBy` integer, nullable
      - `createdBy` integer, nullable
      - `updatedDateUTC` string, date-time
      - `createdDateUTC` string, date-time
      - `primaryComputers` GetComputerResponse[], nullable
      - `additionalComputers` GetComputerResponse[], nullable
      - `user` GetUserResponse
        - `id` integer
        - `email` string, nullable
        - `name` string, nullable
        - `tenantId` integer
        - `isAdmin` boolean
        - `isMsp` boolean
        - `companyName` string, nullable
        - `type` string, nullable
        - `azurePrincipalId` string, nullable
        - `isExpired` boolean
        - `expirationDateUTC` string, date-time, nullable
        - `personId` integer, nullable
        - `canManageCrossTenantDeployments` boolean
        - `groupCount` integer
        - `groups` string[], nullable
        - `directRoleCount` integer
      - `userAffinities` GetUserAffinityResponse[], nullable
        - `id` integer
        - `computerId` integer
        - `personId` integer
        - `date` string, date-time
        - `person` GetPersonResponse (recursive)
    - `primaryPerson` GetPersonResponse
      - `id` integer
      - `tenantId` integer
      - `azurePrincipalId` string, nullable
      - `firstName` string, nullable
      - `lastName` string, nullable
      - `emailAddress` string, nullable
      - `displayName` string, nullable
      - `updatedBy` integer, nullable
      - `createdBy` integer, nullable
      - `updatedDateUTC` string, date-time
      - `createdDateUTC` string, date-time
      - `primaryComputers` GetComputerResponse[], nullable
      - `additionalComputers` GetComputerResponse[], nullable
      - `user` GetUserResponse
        - `id` integer
        - `email` string, nullable
        - `name` string, nullable
        - `tenantId` integer
        - `isAdmin` boolean
        - `isMsp` boolean
        - `companyName` string, nullable
        - `type` string, nullable
        - `azurePrincipalId` string, nullable
        - `isExpired` boolean
        - `expirationDateUTC` string, date-time, nullable
        - `personId` integer, nullable
        - `canManageCrossTenantDeployments` boolean
        - `groupCount` integer
        - `groups` string[], nullable
        - `directRoleCount` integer
      - `userAffinities` GetUserAffinityResponse[], nullable
        - `id` integer
        - `computerId` integer
        - `personId` integer
        - `date` string, date-time
        - `person` GetPersonResponse (recursive)
    - `tenant` GetTenantResponse
      - `id` integer
      - `name` string, nullable, required
      - `slug` string, nullable
      - `parentTenantId` integer, nullable
      - `ownerTenantId` integer, nullable
      - `active` boolean
      - `azureTenantLink` AzureTenantLinkResponse
        - `immyTenantId` integer
        - `azTenantId` string, nullable
        - `azureTenant` AzureTenantResponse
          - `principalId` string, nullable
          - `consentDetails` AzureTenantConsentDetails
            - `consentedWith` 'Backend' | 'Custom': The string or integer value may be used. Backend = 0, Custom = 1
            - `consentDateUtc` string, date-time, nullable
          - `azureTenantType` 'Partner' | 'Customer' | 'Standalone': The string or integer value may be used. Partner = 1, Customer = 2, Standalone = 3
          - `partnerPrincipalId` string, nullable
          - `infoSyncedFromAzure` AzureTenantInfo
            - `tenantName` string, nullable, required
            - `defaultDomainName` string, nullable
            - `domainNames` string[], nullable
          - `lastGetUsersSyncResult` AzureSyncResult
            - `attemptDateUtc` string, date-time
            - `attemptFailedErrorId` string, uuid, nullable
          - `lastGetTenantInfoSyncResult` AzureSyncResult
            - `attemptDateUtc` string, date-time
            - `attemptFailedErrorId` string, uuid, nullable
        - `shouldLimitDomains` boolean
        - `limitToDomains` AzureTenantLinkDomainFilter[], nullable
          - `immyTenantId` integer, required
          - `azTenantId` string, nullable, required
          - `domainName` string, nullable, required
      - `isMsp` boolean
      - `updatedBy` integer, nullable
      - `updatedDateUTC` string, date-time
      - `createdBy` integer, nullable
      - `createdDateUTC` string, date-time
      - `tenantTagIds` integer[], nullable
      - `tenantTagNames` string[], nullable
      - `markedForDeletionAtUtc` string, date-time, nullable
    - `agents` GetProviderAgentResponse[], nullable
      - `agentVersion` SemanticVersion
        - `major` integer
        - `minor` integer
        - `patch` integer
        - `releaseLabels` string[], nullable
        - `release` string, nullable
        - `isPrerelease` boolean
        - `hasMetadata` boolean
        - `metadata` string, nullable
      - `id` integer
      - `computerId` integer, nullable
      - `providerLinkId` integer
      - `externalClientName` string, nullable
      - `externalClientId` string, nullable
      - `externalAgentId` ExternalAgentId
        - `value` string, nullable
      - `runScriptPriority` integer
      - `providerTypeId` string, uuid
      - `internalData` unknown
      - `isOnline` boolean
      - `supportsRunningScripts` boolean
      - `deviceUpdateFormData` unknown
      - `lastUpdatedUTC` string, date-time
      - `deviceDetails` DeviceDetails
        - `operatingSystemName` string, nullable
        - `manufacturer` string, nullable
        - `deviceName` string, nullable
        - `serialNumber` string, nullable
        - `deviceId` string, uuid, nullable
        - `osInstallDateUTC` string, date-time, nullable
        - `machineId` string, nullable
        - `isSandbox` boolean
        - `domain` string, nullable
        - `azureTenantId` string, nullable
        - `domainRole` integer, nullable
        - `chassisTypes` integer[], nullable
      - `onboardingOptions` AgentOnboardingOptions
        - `automaticallyOnboard` boolean
        - `onboardingCorrelationId` string, nullable
        - `onboardingSessionRebootPreference` 'Normal' | 'Suppress' | 'Prompt' | 'Force': The string or integer value may be used. Normal = 0, Suppress = 1, Prompt = 2, Force = -1
        - `onboardingSessionPromptTimeoutAction` 'Reboot' | 'Suppress' | 'FailSession': The string or integer value may be used. Reboot = 0, Suppress = 1, FailSession = 2
        - `onboardingSessionAutoConsentToReboots` boolean
        - `onboardingSessionPromptTimeoutMinutes` integer
        - `onboardingSessionSendFollowUpEmail` boolean
        - `primaryPersonId` integer, nullable
        - `additionalPersonIds` integer[], nullable
        - `tags` integer[], nullable
        - `isDevLab` boolean
      - `requireManualIdentification` boolean
    - `computerTagIds` integer[], nullable
  - `tenant` GetTenantResponse
    - `id` integer
    - `name` string, nullable, required
    - `slug` string, nullable
    - `parentTenantId` integer, nullable
    - `ownerTenantId` integer, nullable
    - `active` boolean
    - `azureTenantLink` AzureTenantLinkResponse
      - `immyTenantId` integer
      - `azTenantId` string, nullable
      - `azureTenant` AzureTenantResponse
        - `principalId` string, nullable
        - `consentDetails` AzureTenantConsentDetails
          - `consentedWith` 'Backend' | 'Custom': The string or integer value may be used. Backend = 0, Custom = 1
          - `consentDateUtc` string, date-time, nullable
        - `azureTenantType` 'Partner' | 'Customer' | 'Standalone': The string or integer value may be used. Partner = 1, Customer = 2, Standalone = 3
        - `partnerPrincipalId` string, nullable
        - `infoSyncedFromAzure` AzureTenantInfo
          - `tenantName` string, nullable, required
          - `defaultDomainName` string, nullable
          - `domainNames` string[], nullable
        - `lastGetUsersSyncResult` AzureSyncResult
          - `attemptDateUtc` string, date-time
          - `attemptFailedErrorId` string, uuid, nullable
        - `lastGetTenantInfoSyncResult` AzureSyncResult
          - `attemptDateUtc` string, date-time
          - `attemptFailedErrorId` string, uuid, nullable
      - `shouldLimitDomains` boolean
      - `limitToDomains` AzureTenantLinkDomainFilter[], nullable
        - `immyTenantId` integer, required
        - `azTenantId` string, nullable, required
        - `domainName` string, nullable, required
    - `isMsp` boolean
    - `updatedBy` integer, nullable
    - `updatedDateUTC` string, date-time
    - `createdBy` integer, nullable
    - `createdDateUTC` string, date-time
    - `tenantTagIds` integer[], nullable
    - `tenantTagNames` string[], nullable
    - `markedForDeletionAtUtc` string, date-time, nullable

---

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