V1PackageCreateViewModel

Source: Robopack public API v1 OpenAPI definition · OpenAPI 3.0.1 · Snapshot: 2026-10-01. Download this snapshot.

Type: object

Attribute	Value
Required properties	name

Property	Type	Required	Nullable	Constraints / default	Description
architecture	MemProcessorArchitecture2	No	Not declared	—	—
detectionRules	array of MemDetectionMethod	No	Not declared	—	Detection rule(s) to use for detecting the installation of the package. Required if 'runAnalysis' is not enabled.
installCommand	string	No	Yes	—	Command used to run the installation of the package.
logoData	string (byte)	No	Yes	—	Logo for the package as BASE64-encoded data. Standard image formats are supported (PNG, JPEG, etc.)
name	string	Yes	Not declared	—	Name of the package to create.
publisher	string	No	Yes	—	Publisher name for package.
runAnalysis	boolean	No	Not declared	—	If Robopack should run an installation analysis of the package to verify the installation command and attempt to determine the uninstall command and detection rule.
scriptTemplateId	string (uuid)	No	Yes	—	ID of script template to use for creating the package.
sourceType	string	No	Yes	—	Type of source files for the package. One of 'zip', 'exe', 'msi'.
uninstallCommand	string	No	Yes	—	Command used to run the uninstallation of the package. Required if 'runAnalysis' is not enabled.
userContext	boolean	No	Not declared	—	Set to true if the package installs in the user context, false for machine context.
version	string	No	Yes	—	Version of package.

Required property status follows the schema's required list. Nullability and defaults are shown only where declared; a missing declaration does not establish backend behavior.

Related models

• MemDetectionMethod
• MemProcessorArchitecture2

Operations using this model directly

• POST /v1/package/create

Complete schema definition

{
  "properties": {
    "architecture": {
      "$ref": "#/components/schemas/MemProcessorArchitecture2"
    },
    "detectionRules": {
      "description": "Detection rule(s) to use for detecting the installation of the package. Required if 'runAnalysis' is not enabled.",
      "items": {
        "$ref": "#/components/schemas/MemDetectionMethod"
      },
      "type": "array"
    },
    "installCommand": {
      "description": "Command used to run the installation of the package.",
      "nullable": true,
      "type": "string"
    },
    "logoData": {
      "description": "Logo for the package as BASE64-encoded data. Standard image formats are supported (PNG, JPEG, etc.)",
      "format": "byte",
      "nullable": true,
      "type": "string"
    },
    "name": {
      "description": "Name of the package to create.",
      "type": "string"
    },
    "publisher": {
      "description": "Publisher name for package.",
      "nullable": true,
      "type": "string"
    },
    "runAnalysis": {
      "description": "If Robopack should run an installation analysis of the package to verify the installation command and attempt to determine the uninstall command and detection rule.",
      "type": "boolean"
    },
    "scriptTemplateId": {
      "description": "ID of script template to use for creating the package.",
      "format": "uuid",
      "nullable": true,
      "type": "string"
    },
    "sourceType": {
      "description": "Type of source files for the package. One of 'zip', 'exe', 'msi'.",
      "nullable": true,
      "type": "string"
    },
    "uninstallCommand": {
      "description": "Command used to run the uninstallation of the package. Required if 'runAnalysis' is not enabled.",
      "nullable": true,
      "type": "string"
    },
    "userContext": {
      "description": "Set to true if the package installs in the user context, false for machine context.",
      "type": "boolean"
    },
    "version": {
      "description": "Version of package.",
      "nullable": true,
      "type": "string"
    }
  },
  "required": [
    "name"
  ],
  "type": "object"
}