Discover Device Component
POST/api/v2/device/discover/component
This service message allows a device to post the discovery context for getting device software offers.
Request
- application/json
Body
required
Array [
]
Array [
]
Timestamp when the discovery snapshot was taken
Name or ID (as string) of the deviceType (e.g., router, switch, server, etc.), used for discovery of devices of type "device"
platform
object
Name or ID (as string) of the platform type being discovered.
ID (as string) of system or machine being discovered.
Array of devices discovered within this platform. Each device contains detailed discovery information of type "DiscoveryMessageV2Dto".
deviceData
object
Timestamp of the last metadata snapshot
Device identifier
Device type tokens
Platform identifier
Platform name
Available GetApp server URLs
Delivery source mode
When true, requests that a master agent orchestrate this device
When true, the device subscribes to the master SSE command channel
Master device-id that is currently orchestrating this device
Orchestrator identifier
metadata
object
Device metadata. Known fields are listed above. Any additional key-value pairs reported by the agent are flattened into this object (mirrors the Rust serde flatten pattern).
MAC address
IP address
Device name
location
object
Operating system
OS release version
Available storage in bytes
battery
object
Battery level as a percentage (0–100)
Battery health as a percentage (0–100)
Estimated time remaining in minutes
Battery state: Charging | Discharging | Full | Empty | Unknown
Whether this is a virtual/emulated battery
Currently active GetApp server URL
Device metadata. Known fields are listed above. Any additional key-value pairs reported by the agent are flattened into this object (mirrors the Rust serde flatten pattern).
general
object
personalDevice
object
situationalDevice
object
location
object
physicalDevice
object
Possible values: [android, windows, linux, macos]
Possible values: [get-app, get-map, mTls]
softwareData
object
components
object[]
Possible values: [offering, push, delivery, downloaded, deleted, deploy, installed, uninstalled]
supportedFields
object[]
List of fields that the device supports for evaluation, including their types (e.g., number, string, boolean)
Field name in JSONPath format (e.g., $.battery.level)
Field data type (number, string, boolean)
Human-readable label for the field
Field description
Responses
- 200
- application/json
- Schema
- Example (from schema)
Schema
Array [
Array [
Array [
]
]
]
Array [
Array [
Array [
]
]
]
Array [
Array [
Array [
]
]
Array [
Array [
]
]
]
Array [
]
offer
object[]
required
deprecated
Use 'releases' field instead
Human-readable display name of the project
Label associated with the project
Application category (user or technician)
metadata
object
Enable automatic deployment of this release
postInstallAction
object
Post-installation action configuration
Possible values: [NONE, WEB, EXE]
Action type: NONE (no action), WEB (open URL), or EXE (run executable)
URL to open (required when type is WEB)
Executable path to run (required when type is EXE)
Installation size in bytes - disk space required after installation (user-specified)
Total size in bytes - automatically calculated as installationSize + artifactsSize
Hide this release from agents if the health check URL is not healthy
URL to check for health status. Required when hideIfNotHealthy is true.
Interval in seconds between health check requests. Required when healthCheckUrl is set.
Possible values: [draft, in_review, approved, released, archived, error]
Possible values: [product, application, lib, bundle, infra, config, config_map]
Possible values: [product, application, lib, bundle, infra, config, config_map]
The actual project type, regardless of agent compatibility
policies
object[]
Policies associated with this release
Policy rule ID
Policy name
Policy description
Possible values: [policy, restriction]
Policy type
association
object
releases
object[]
required
Releases for this policy
Project ID
Project name
Release version
Policy version number
Policy creation timestamp
Policy last update timestamp
Whether the policy is active
Default value: false
Whether this policy should be pushed to agents
The policy rule definition conforming to rule engine schema
push
object[]
required
deprecated
Use 'releases' field instead
Human-readable display name of the project
Label associated with the project
Application category (user or technician)
metadata
object
Enable automatic deployment of this release
postInstallAction
object
Post-installation action configuration
Possible values: [NONE, WEB, EXE]
Action type: NONE (no action), WEB (open URL), or EXE (run executable)
URL to open (required when type is WEB)
Executable path to run (required when type is EXE)
Installation size in bytes - disk space required after installation (user-specified)
Total size in bytes - automatically calculated as installationSize + artifactsSize
Hide this release from agents if the health check URL is not healthy
URL to check for health status. Required when hideIfNotHealthy is true.
Interval in seconds between health check requests. Required when healthCheckUrl is set.
Possible values: [draft, in_review, approved, released, archived, error]
Possible values: [product, application, lib, bundle, infra, config, config_map]
Possible values: [product, application, lib, bundle, infra, config, config_map]
The actual project type, regardless of agent compatibility
policies
object[]
Policies associated with this release
Policy rule ID
Policy name
Policy description
Possible values: [policy, restriction]
Policy type
association
object
releases
object[]
required
Releases for this policy
Project ID
Project name
Release version
Policy version number
Policy creation timestamp
Policy last update timestamp
Whether the policy is active
Default value: false
Whether this policy should be pushed to agents
The policy rule definition conforming to rule engine schema
releases
object[]
required
Components with all additional data of platform and device type hierarchy, project and actions
release
object
Human-readable display name of the project
Label associated with the project
Application category (user or technician)
metadata
object
Component metadata including autoDeploy and postInstallAction configuration. Additional user-defined properties are supported.
Enable automatic deployment of this release
postInstallAction
object
Post-installation action configuration
Possible values: [NONE, WEB, EXE]
Action type: NONE (no action), WEB (open URL), or EXE (run executable)
URL to open (required when type is WEB)
Executable path to run (required when type is EXE)
Installation size in bytes - disk space required after installation (user-specified)
Total size in bytes - automatically calculated as installationSize + artifactsSize
Hide this release from agents if the health check URL is not healthy
URL to check for health status. Required when hideIfNotHealthy is true.
Interval in seconds between health check requests. Required when healthCheckUrl is set.
Possible values: [draft, in_review, approved, released, archived, error]
Possible values: [product, application, lib, bundle, infra, config, config_map]
Possible values: [product, application, lib, bundle, infra, config, config_map]
The actual project type, regardless of agent compatibility
policies
object[]
Policies associated with this release
Policy rule ID
Policy name
Policy description
Possible values: [policy, restriction]
Policy type
association
object
required
Policy associations (releases, device types, OS types, devices)
releases
object[]
required
Releases for this policy
Project ID
Project name
Release version
Policy version number
Policy creation timestamp
Policy last update timestamp
Whether the policy is active
Default value: false
Whether this policy should be pushed to agents
The policy rule definition conforming to rule engine schema
Default value: false
Flag indicating if this is a push action
hierarchyTrees
object[]
required
Platform and device type hierarchy where this release is offered
Platform Type ID - present when device types are under a platform type
Platform Type name - present when device types are under a platform type
deviceTypes
object[]
required
Device types with projects (under platform if platform fields are present, or standalone)
ID of the device type
Name of the device type
ID of the project
Name of the project
Display name of the project
Label of the project
Application category (user or technician)
Array of catalog IDs of releases that directly depend on this release
Array of managed device IDs that this release is pushed to
Default value: true
Indicates whether this release is available for delivery (true when release status is not error)
restrictions
object[]
required
List of applicable restrictions for the device based on device ID, device type, OS, and other metadata
Possible values: [policy, restriction]
The restriction rule object
The semVer of the latest ACTIVE config revision for this device. The device should compare this with its locally cached version and fetch from GET /v2/device/device-config/:deviceId if they differ.
List of device IDs whose CONFIG projects this agent should also download and cache locally. For each deviceId in this list, call GET /v2/device/device-config/:deviceId.
{
"releases": [
{
"release": {
"id": "string",
"version": "string",
"projectId": 0,
"projectName": "string",
"displayName": "string",
"label": "string",
"applicationCategory": "string",
"releaseNotes": "string",
"metadata": {
"autoDeploy": true,
"postInstallAction": {
"type": "NONE",
"url": "string",
"exePath": "string"
},
"installationSize": 0,
"totalSize": 0,
"hideIfNotHealthy": true,
"healthCheckUrl": "string",
"healthCheckIntervalSeconds": 0
},
"status": "draft",
"projectTypeV2": "product",
"size": 0,
"createdAt": "2026-06-22T12:47:52.450Z",
"updatedAt": "2026-06-22T12:47:52.450Z",
"latest": true,
"releasedAt": "2026-06-22T12:47:52.450Z",
"dependencies": [
null
],
"policies": [
{
"id": "string",
"name": "string",
"description": "string",
"type": "policy",
"association": {
"releases": [
{
"projectId": "string",
"projectName": "string",
"version": "string"
}
]
},
"version": 0,
"createdAt": "string",
"updatedAt": "string",
"isActive": true,
"isPush": false,
"rule": {}
}
]
},
"isPush": false,
"hierarchyTrees": [
{
"platformTypeId": 0,
"platformTypeName": "string",
"deviceTypes": [
{
"deviceTypeId": 0,
"deviceTypeName": "string",
"projectId": 0,
"projectName": "string",
"projectDisplayName": "string",
"projectLabel": "string",
"projectApplicationCategory": "string"
}
]
}
],
"dependedOnBy": [
"string"
],
"pushTo": [
"string"
],
"available": true
}
],
"restrictions": [
{
"id": "string",
"name": "string",
"description": "string",
"type": "policy",
"version": 0,
"isActive": true,
"rule": {},
"createdAt": "string",
"updatedAt": "string"
}
],
"latestConfigSemVer": "string",
"configDeviceIds": [
"string"
]
}