---
title: "POST /api/v1/run-immy-service-new"
method: POST
path: "/api/v1/run-immy-service-new"
tags: ["Immybot"]
---

# POST /api/v1/run-immy-service-new

`POST /api/v1/run-immy-service-new`

## 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/run-immy-service-new`
- Auth: none declared

## Request body

- RunImmyServiceRequestBody
  - `computers` RunImmybotComputerRequestBody[], nullable
    - `computerId` integer
    - `maintenanceTaskParameterValueOverrides` object, nullable
  - `tenants` RunImmybotTenantRequestBody[], nullable
    - `tenantId` integer
    - `maintenanceTaskParameterValueOverrides` object, nullable
  - `persons` RunImmybotPersonRequestBody[], nullable
    - `personId` integer
    - `maintenanceTaskParameterValueOverrides` object, nullable
  - `maintenanceParams` RunImmybotMaintenanceRequestBody
    - `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
    - `repair` boolean
    - `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
    - `softwareProviderType` 'Ninite' | 'Chocolatey' | 'Inherent': The string or integer value may be used. Ninite = 1, Chocolatey = 2, Inherent = 3
    - `semanticVersion` SemanticVersion
      - `major` integer
      - `minor` integer
      - `patch` integer
      - `releaseLabels` string[], nullable
      - `release` string, nullable
      - `isPrerelease` boolean
      - `hasMetadata` boolean
      - `metadata` string, nullable
    - `semanticVersionNormalized` string, nullable
    - `maintenanceTaskMode` 'Enforce' | 'Audit' | 'Monitor' | 'NoAction': The string or integer value may be used. Enforce = 0, Audit = 1, Monitor = 2, NoAction = 3
    - `taskParameterValues` object, 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
  - `skipBackgroundJob` boolean: If true then hangfire is not used
  - `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
  - `licenseId` integer, nullable
  - `updateTime` string, nullable
  - `timeZoneInfoId` string, nullable
  - `useComputersTimezoneForExecution` boolean
  - `scheduleExecutionAfterActiveHours` boolean
  - `fullMaintenance` boolean
  - `detectionOnly` boolean
  - `resolutionOnly` boolean
  - `inventoryOnly` boolean
  - `runInventoryInDetection` boolean
  - `deploymentId` integer, nullable
  - `deploymentType` 'Global' | 'Local': The string or integer value may be used. Global = 0, Local = 1
  - `offlineBehavior` 'Skip' | 'ApplyOnConnect': The string or integer value may be used. Skip = 1, ApplyOnConnect = 2
  - `suppressRebootsDuringBusinessHours` boolean
  - `sendDetectionEmail` boolean
  - `sendDetectionEmailWhenAllActionsAreCompliant` boolean
  - `sendFollowUpEmail` boolean
  - `sendFollowUpOnlyIfActionNeeded` boolean
  - `showRunNowButton` boolean
  - `showPostponeButton` boolean
  - `showMaintenanceActions` boolean
  - `useWinningDeployment` boolean
  - `sessionGroupId` string, uuid, nullable
  - `providerLinkIdForAgentUpdates` integer, nullable
  - `propagateToChildTenants` boolean
  - `allowAccessToParentTenant` boolean

## Response `200`

OK

---

[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)