ESET Online Help

Search
Select the category
Select the topic

GET Get installer description

Relative path: /v1/installers/{installerUuid}

Parameters in path

Name

Type

Required

Description

installerUuid

string

Yes

Reference to the requested [installer].

type: Installer



Responses

Display Schema instead of an Example or vice-versa

Code

Description

Example

Schema

200

A successful response.

{
  "installer": {
    "activatedProducts": [
      {
        "poolUuid": "string",
        "poolDisplayName": "string",
        "productId": 0,
        "productDisplayName": "string",
        "subscriptionUuid": "string",
        "subscriptionSupportCode": "string"
      }
    ],
    "createTime": "string",
    "deviceEnrollment": {
      "groupDisplayName": "string",
      "securityGroupUuid": "string"
    },
    "displayName": "string",
    "downloadUrl": "string",
    "enableCloudScannerFeedback": true,
    "enablePuaDetection": true,
    "expireTime": "string",
    "installedComponents": [
      {
        "displayName": "string",
        "id": 0,
        "name": "string"
      }
    ],
    "operatingSystemFamilyId": 0,
    "preferredLanguageCode": "string",
    "sendAnonymousDiagnosticData": true,
    "usable": true,
    "uuid": "string"
  }
}
{
  "$ref": "v1GetInstallerResponse",
  "installer": {
    "$ref": "v1Installer",
    "description": "Describes installer entity. Installer: 1. drops one or more components on target device(s) 2. activates one or more products on target device(s) 3. enrolls target device into device management under some security group.",
    "activatedProducts": [
      {
        "$ref": "v1ActivatedProduct",
        "description": "Describes product activated (enabled) after installation. Migration notice: In EP(c) GUI ActivatedProduct maps to License.",
        "poolUuid": {
          "type": "string",
          "description": "[Unit pool] reference. Migration notice: Unit Pool maps to older License Pool. type: unit_management.v1.UnitPool"
        },
        "poolDisplayName": {
          "type": "string",
          "description": "Human readable name of [unit pool]. Migration notice: pool_display_name is in EP(c) GUI rendered as License User."
        },
        "productId": {
          "type": "integer",
          "description": "Reference to [activated product]. type: product_catalog.v1.Product",
          "format": "int64"
        },
        "productDisplayName": {
          "type": "string",
          "description": "Display name of [activated product]."
        },
        "subscriptionUuid": {
          "type": "string",
          "description": "Reference to a [subscription] from where the units will be used. Migration notice: For licenses issued before 2024 can be put equal to EDF license_uuid. type: subscription_management.v1.Subscription"
        },
        "subscriptionSupportCode": {
          "type": "string",
          "description": "User-friendly code used in support-related situations. Generated by system at subscription creation, cannot be updated. Migration notice: For licenses issued before 2024 it is equal to Public License ID."
        }
      }
    ],
    "createTime": {
      "type": "string",
      "description": "When installer was created. read-only For details see https://github.com/protocolbuffers/protobuf/blob/main/src/google/protobuf/timestamp.proto.",
      "format": "date-time"
    },
    "deviceEnrollment": {
      "$ref": "v1DeviceEnrollmentSettings",
      "description": "Describes how device enrolls into device management after installation.",
      "groupDisplayName": {
        "type": "string",
        "description": "Display name of the future parent device group."
      },
      "securityGroupUuid": {
        "type": "string",
        "description": "Security group to become member of. If empty then 1. either device name matches some existing device and its group is used. 2. lost and found is used otherwise Migration notice: UUID of a static group can be used here. type: iam.v2.SecurityGroup"
      }
    },
    "displayName": {
      "type": "string",
      "description": "Human readable name of the installer."
    },
    "downloadUrl": {
      "type": "string",
      "description": "Installer can be downloaded at this URL. read-only"
    },
    "enableCloudScannerFeedback": {
      "type": "boolean",
      "description": "If true, installed protections would use ESET cloud scanning."
    },
    "enablePuaDetection": {
      "type": "boolean",
      "description": "If true detection of potentially unwanted applications would be enabled."
    },
    "expireTime": {
      "type": "string",
      "description": "Installers are created with automatically determined life-span. After expire_time they become unusable. read-only For details see https://github.com/protocolbuffers/protobuf/blob/main/src/google/protobuf/timestamp.proto.",
      "format": "date-time"
    },
    "installedComponents": [
      {
        "$ref": "v1PlatformComponent",
        "displayName": {
          "type": "string",
          "description": "Human readable name of the component. Derived from package display_name."
        },
        "id": {
          "type": "integer",
          "description": "Identifier of governed resource. Can be seen as a value of item in enumerated type. It can be derived from name by some algorithm such as CRC32.",
          "format": "int64"
        },
        "name": {
          "type": "string",
          "description": "Name of the governed item. Can be seen as a name of enumeration item, with id being its numerical value. Note: Not to be confused with display_name, which is purposed for UI."
        }
      }
    ],
    "operatingSystemFamilyId": {
      "type": "integer",
      "description": "Which operating system family the installer supports. 0 = Unspecified 1 = Windows 2 = Linux 3 = Mac OS",
      "format": "int64"
    },
    "preferredLanguageCode": {
      "type": "string",
      "description": "Code of preferred GUI language in BCP-47 format. A default 'en-us' is used if preferred language is not available."
    },
    "sendAnonymousDiagnosticData": {
      "type": "boolean",
      "description": "If true, installed components would take part in improvement program by sending anonymous diagnostic data, such as crash reports and crash dumps."
    },
    "usable": {
      "type": "boolean",
      "description": "If true, the installer can be used. If false, installer cannot be used from various reasons (e.g. expiration). read-only"
    },
    "uuid": {
      "type": "string",
      "description": "Unique identifier of the entity. Must be collision free - two identifiers created anywhere in the world must not collide within entity parent scope. Unless a member of aggregate, the entity scope is always global. Although most of the times compliant with RFC 4122: A Universally Unique IDentifier (UUID) URN Namespace, do not rely on it being a RFC UUID. Treat it as an opaque identifier. RFC UUID can be recognized by being formatted according to template xxxxxxxx-xxxx-Mxxx-Nxxx-xxxxxxxxxxxx, as explained on wikipedia. UUID is used for referencing an entity, even across domains. Example: '123e4567-e89b-12d3-a456-426614174000'"
    }
  }
}

default

An unexpected error response.

{
  "code": 0,
  "message": "string",
  "details": [
    {
      "@type": "string"
    }
  ]
}
{
  "$ref": "rpcStatus",
  "code": {
    "type": "integer",
    "format": "int32"
  },
  "message": {
    "type": "string"
  },
  "details": [
    {
      "$ref": "protobufAny",
      "@type": {
        "type": "string"
      }
    }
  ]
}

202

Response took too long and the request was cached.

null
[]