---
title: "POST /api/v1/software/local/analyze"
method: POST
path: "/api/v1/software/local/analyze"
tags: ["Software"]
---

# POST /api/v1/software/local/analyze

`POST /api/v1/software/local/analyze`

## 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/software/local/analyze`
- Auth: none declared

## Request body

- AnalyzePackageParams
  - `blobName` string, nullable
  - `url` string, nullable
  - `fileName` string, nullable

## Response `200`

OK

- AnalyzeLocalSoftwarePackageResponse
  - `fileName` string, nullable
  - `packageHash` string, nullable
  - `packageType` 'None' | 'EntireFolder' | 'InstallerFile': The string or integer value may be used. None = 0, EntireFolder = 1, InstallerFile = 2
  - `displayVersion` string, nullable
  - `extension` string, nullable
  - `description` string, nullable
  - `softwareTableName` string, nullable
  - `upgradeCode` string, uuid, nullable
  - `productCode` string, uuid, nullable
  - `isExe` boolean
  - `isMsi` boolean
  - `powerShellInstallScript` IScriptDetailsBase
    - `action` string, nullable
    - `name` string, nullable
    - `scriptLanguage` 'CommandLine' | 'PowerShell': The string or integer value may be used. CommandLine = 1, PowerShell = 2
    - `scriptExecutionContext` 'System' | 'CurrentUser' | 'Metascript' | 'CloudScript': The string or integer value may be used. System = 0, CurrentUser = 1, Metascript = 2, CloudScript = 4
    - `databaseType` 'Global' | 'Local': The string or integer value may be used. Global = 0, Local = 1
    - `scriptCategory` 'SoftwareDetection' | 'SoftwareVersionAction' | 'MaintenanceTaskSetter' | 'MetascriptDeploymentTarget' | 'FilterScriptDeploymentTarget' | 'DeviceInventory' | 'Function' | 'ImmySystem' | 'DynamicVersions' | 'DownloadInstaller' | 'Module' | 'Preflight' | 'Integration': The string or integer value may be used. SoftwareDetection = 0, SoftwareVersionAction = 2, MaintenanceTaskSetter = 3, MetascriptDeploymentTarget = 4, FilterScriptDeploymentTarget = 5, DeviceInventory = 6, Function = 7, ImmySystem = 8, DynamicVersions = 9, DownloadInstaller = 10, Module = 11, Preflight = 12, Integration = 13
    - `outputType` 'Object' | 'Table': The string or integer value may be used. Object = 0, Table = 1
    - `timeout` integer, nullable
    - `filterScriptMode` 'Legacy' | 'Optimized': The string or integer value may be used. Legacy = 0, Optimized = 1
  - `batchInstallScript` IScriptDetailsBase
    - `action` string, nullable
    - `name` string, nullable
    - `scriptLanguage` 'CommandLine' | 'PowerShell': The string or integer value may be used. CommandLine = 1, PowerShell = 2
    - `scriptExecutionContext` 'System' | 'CurrentUser' | 'Metascript' | 'CloudScript': The string or integer value may be used. System = 0, CurrentUser = 1, Metascript = 2, CloudScript = 4
    - `databaseType` 'Global' | 'Local': The string or integer value may be used. Global = 0, Local = 1
    - `scriptCategory` 'SoftwareDetection' | 'SoftwareVersionAction' | 'MaintenanceTaskSetter' | 'MetascriptDeploymentTarget' | 'FilterScriptDeploymentTarget' | 'DeviceInventory' | 'Function' | 'ImmySystem' | 'DynamicVersions' | 'DownloadInstaller' | 'Module' | 'Preflight' | 'Integration': The string or integer value may be used. SoftwareDetection = 0, SoftwareVersionAction = 2, MaintenanceTaskSetter = 3, MetascriptDeploymentTarget = 4, FilterScriptDeploymentTarget = 5, DeviceInventory = 6, Function = 7, ImmySystem = 8, DynamicVersions = 9, DownloadInstaller = 10, Module = 11, Preflight = 12, Integration = 13
    - `outputType` 'Object' | 'Table': The string or integer value may be used. Object = 0, Table = 1
    - `timeout` integer, nullable
    - `filterScriptMode` 'Legacy' | 'Optimized': The string or integer value may be used. Legacy = 0, Optimized = 1
  - `powerShellUninstallScript` IScriptDetailsBase
    - `action` string, nullable
    - `name` string, nullable
    - `scriptLanguage` 'CommandLine' | 'PowerShell': The string or integer value may be used. CommandLine = 1, PowerShell = 2
    - `scriptExecutionContext` 'System' | 'CurrentUser' | 'Metascript' | 'CloudScript': The string or integer value may be used. System = 0, CurrentUser = 1, Metascript = 2, CloudScript = 4
    - `databaseType` 'Global' | 'Local': The string or integer value may be used. Global = 0, Local = 1
    - `scriptCategory` 'SoftwareDetection' | 'SoftwareVersionAction' | 'MaintenanceTaskSetter' | 'MetascriptDeploymentTarget' | 'FilterScriptDeploymentTarget' | 'DeviceInventory' | 'Function' | 'ImmySystem' | 'DynamicVersions' | 'DownloadInstaller' | 'Module' | 'Preflight' | 'Integration': The string or integer value may be used. SoftwareDetection = 0, SoftwareVersionAction = 2, MaintenanceTaskSetter = 3, MetascriptDeploymentTarget = 4, FilterScriptDeploymentTarget = 5, DeviceInventory = 6, Function = 7, ImmySystem = 8, DynamicVersions = 9, DownloadInstaller = 10, Module = 11, Preflight = 12, Integration = 13
    - `outputType` 'Object' | 'Table': The string or integer value may be used. Object = 0, Table = 1
    - `timeout` integer, nullable
    - `filterScriptMode` 'Legacy' | 'Optimized': The string or integer value may be used. Legacy = 0, Optimized = 1
  - `detectionScript` IScriptDetailsBase
    - `action` string, nullable
    - `name` string, nullable
    - `scriptLanguage` 'CommandLine' | 'PowerShell': The string or integer value may be used. CommandLine = 1, PowerShell = 2
    - `scriptExecutionContext` 'System' | 'CurrentUser' | 'Metascript' | 'CloudScript': The string or integer value may be used. System = 0, CurrentUser = 1, Metascript = 2, CloudScript = 4
    - `databaseType` 'Global' | 'Local': The string or integer value may be used. Global = 0, Local = 1
    - `scriptCategory` 'SoftwareDetection' | 'SoftwareVersionAction' | 'MaintenanceTaskSetter' | 'MetascriptDeploymentTarget' | 'FilterScriptDeploymentTarget' | 'DeviceInventory' | 'Function' | 'ImmySystem' | 'DynamicVersions' | 'DownloadInstaller' | 'Module' | 'Preflight' | 'Integration': The string or integer value may be used. SoftwareDetection = 0, SoftwareVersionAction = 2, MaintenanceTaskSetter = 3, MetascriptDeploymentTarget = 4, FilterScriptDeploymentTarget = 5, DeviceInventory = 6, Function = 7, ImmySystem = 8, DynamicVersions = 9, DownloadInstaller = 10, Module = 11, Preflight = 12, Integration = 13
    - `outputType` 'Object' | 'Table': The string or integer value may be used. Object = 0, Table = 1
    - `timeout` integer, nullable
    - `filterScriptMode` 'Legacy' | 'Optimized': The string or integer value may be used. Legacy = 0, Optimized = 1
  - `defaultPowershellUninstallScript` IScriptDetailsBase
    - `action` string, nullable
    - `name` string, nullable
    - `scriptLanguage` 'CommandLine' | 'PowerShell': The string or integer value may be used. CommandLine = 1, PowerShell = 2
    - `scriptExecutionContext` 'System' | 'CurrentUser' | 'Metascript' | 'CloudScript': The string or integer value may be used. System = 0, CurrentUser = 1, Metascript = 2, CloudScript = 4
    - `databaseType` 'Global' | 'Local': The string or integer value may be used. Global = 0, Local = 1
    - `scriptCategory` 'SoftwareDetection' | 'SoftwareVersionAction' | 'MaintenanceTaskSetter' | 'MetascriptDeploymentTarget' | 'FilterScriptDeploymentTarget' | 'DeviceInventory' | 'Function' | 'ImmySystem' | 'DynamicVersions' | 'DownloadInstaller' | 'Module' | 'Preflight' | 'Integration': The string or integer value may be used. SoftwareDetection = 0, SoftwareVersionAction = 2, MaintenanceTaskSetter = 3, MetascriptDeploymentTarget = 4, FilterScriptDeploymentTarget = 5, DeviceInventory = 6, Function = 7, ImmySystem = 8, DynamicVersions = 9, DownloadInstaller = 10, Module = 11, Preflight = 12, Integration = 13
    - `outputType` 'Object' | 'Table': The string or integer value may be used. Object = 0, Table = 1
    - `timeout` integer, nullable
    - `filterScriptMode` 'Legacy' | 'Optimized': The string or integer value may be used. Legacy = 0, Optimized = 1

---

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