MaintenanceSessions

get/api/v1/maintenance-sessions/{sessionId}/phases

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}/phases
  • Auth: none declared

Path parameters

sessionIdinteger required

Response

OK

idinteger
phaseNamestring nullable
actionProgressPhaseName'DetectInstalledAgentVersion' | 'UpdateAgentVersion' | 'VerifyAgentVersionUpdated' | 'DetectInstalledVersion' | 'DetermineDesiredVersion' | 'TestSoftware' | 'CheckForSoftwareLicense' | 'AddConfigTask' | 'TestTask' | 'MonitorTask' | 'AuditTask' | 'FetchDesiredVersion' | 'EnforceTask' | 'ApplyWindowsPatch' | 'DownloadConfigTaskFiles' | 'FetchDependentVersion' | 'InstallDependentVersion' | 'InstallSoftware' | 'RunUpgradeSoftwareScript' | 'UninstallSoftware' | 'RepairSoftware' | 'DownloadInstaller' | 'PostUninstallSoftware' | 'PostInstallSoftware' | 'TestTaskBeforeExecution' | 'TestSoftwareAfterExecution' | 'VerifyTask' | 'VerifySoftwareIsInDesiredState'

The string or integer value may be used. DetectInstalledAgentVersion = 0, UpdateAgentVersion = 1, VerifyAgentVersionUpdated = 2, DetectInstalledVersion = 200, DetermineDesiredVersion = 201, TestSoftware = 202, CheckForSoftwareLicense = 203, AddConfigTask = 204, TestTask = 205, MonitorTask = 206, AuditTask = 207, FetchDesiredVersion = 301, EnforceTask = 302, ApplyWindowsPatch = 305, DownloadConfigTaskFiles = 306, FetchDependentVersion = 307, InstallDependentVersion = 308, InstallSoftware = 309, RunUpgradeSoftwareScript = 310, UninstallSoftware = 311, RepairSoftware = 313, DownloadInstaller = 314, PostUninstallSoftware = 315, PostInstallSoftware = 316, TestTaskBeforeExecution = 317, TestSoftwareAfterExecution = 318, VerifyTask = 319, VerifySoftwareIsInDesiredState = 320

maintenanceSessionIdinteger
maintenanceSessionStageIdinteger
maintenanceActionIdinteger nullable
status'Unstarted' | 'Skipped' | 'Running' | 'Succeeded' | 'Failed'

The string or integer value may be used. Unstarted = 0, Skipped = 1, Running = 2, Succeeded = 3, Failed = 4

progressPercentCompletenumber double nullable
progressStatusstring nullable
progressCompletedboolean
dateStartedUtcstring date-time nullable
dateCompletedUtcstring date-time nullable

Changes

No recorded changes to this operation across all 1 revision of this API.