Discover components by context
POST/api/v2/device/discover/component
Discovers available components and offerings based on provided discovery context. Returns matching component and software offers filtered by the discovery criteria.
Request
- application/json
Body
required
Array [
]
Array [
]
Name or ID (as string) of the deviceType (e.g., router, switch, server, etc.), used for discovery of devices of type "device"
Possible values: [get-app, get-map, mTls]
general
object
personalDevice
object
physicalDevice
object
situationalDevice
object
location
object
platform
object
Array of devices discovered within this platform. Each device contains detailed discovery information of type "DiscoveryMessageV2Dto".
ID (as string) of system or machine being discovered.
Name or ID (as string) of the platform type being discovered.
Timestamp when the discovery snapshot was taken
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 description
Human-readable label for the field
Field name in JSONPath format (e.g., $.battery.level)
Field data type (number, string, boolean)
Responses
- 200
- 400
- 500
Successfully retrieved component offerings
- 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
metadata
object
Enable automatic deployment of this release
Installation size in bytes - disk space required after installation (user-specified)
postInstallAction
object
Executable path to run (required when type is EXE)
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)
Total size in bytes - automatically calculated as installationSize + artifactsSize
policies
object[]
Policies associated with this release
association
object
required
releases
object[]
Associated releases for policies
Project name
Release version
Policy creation timestamp
Policy description
Policy rule ID
Whether the policy is active
Policy name
The policy rule definition conforming to rule engine schema
Possible values: [NONE, WEB, EXE]
Action type: NONE (no action), WEB (open URL), or EXE (run executable)
Policy last update timestamp
Policy version number
Possible values: [start, inProgress, done, error, delete, pending]
Possible values: [NONE, WEB, EXE]
Action type: NONE (no action), WEB (open URL), or EXE (run executable)
push
object[]
required
deprecated
Use 'releases' field instead
Human-readable display name of the project
Label associated with the project
metadata
object
Enable automatic deployment of this release
Installation size in bytes - disk space required after installation (user-specified)
postInstallAction
object
Executable path to run (required when type is EXE)
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)
Total size in bytes - automatically calculated as installationSize + artifactsSize
policies
object[]
Policies associated with this release
association
object
required
releases
object[]
Associated releases for policies
Project name
Release version
Policy creation timestamp
Policy description
Policy rule ID
Whether the policy is active
Policy name
The policy rule definition conforming to rule engine schema
Possible values: [NONE, WEB, EXE]
Action type: NONE (no action), WEB (open URL), or EXE (run executable)
Policy last update timestamp
Policy version number
Possible values: [start, inProgress, done, error, delete, pending]
Possible values: [NONE, WEB, EXE]
Action type: NONE (no action), WEB (open URL), or EXE (run executable)
releases
object[]
required
Components with all additional data of platform and device type hierarchy, project and actions
Array of catalog IDs of releases that directly depend on this release
hierarchyTrees
object[]
required
Platform and device type hierarchy where this release is offered
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
Display name of the project
ID of the project
Label of the project
Name of the project
Platform Type ID - present when device types are under a platform type
Platform Type name - present when device types are under a platform type
Flag indicating if this is a push action
release
object
required
Human-readable display name of the project
Label associated with the project
metadata
object
Enable automatic deployment of this release
Installation size in bytes - disk space required after installation (user-specified)
postInstallAction
object
Executable path to run (required when type is EXE)
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)
Total size in bytes - automatically calculated as installationSize + artifactsSize
policies
object[]
Policies associated with this release
association
object
required
releases
object[]
Associated releases for policies
Project name
Release version
Policy creation timestamp
Policy description
Policy rule ID
Whether the policy is active
Policy name
The policy rule definition conforming to rule engine schema
Possible values: [NONE, WEB, EXE]
Action type: NONE (no action), WEB (open URL), or EXE (run executable)
Policy last update timestamp
Policy version number
Possible values: [start, inProgress, done, error, delete, pending]
Possible values: [NONE, WEB, EXE]
Action type: NONE (no action), WEB (open URL), or EXE (run executable)
restrictions
object[]
required
List of applicable restrictions for the device based on device ID, device type, OS, and other metadata
{
"releases": [
{
"dependedOnBy": [
"string"
],
"hierarchyTrees": [
{
"deviceTypes": [
{
"deviceTypeId": 0,
"deviceTypeName": "string",
"projectDisplayName": "string",
"projectId": 0,
"projectLabel": "string",
"projectName": "string"
}
],
"platformTypeId": 0,
"platformTypeName": "string"
}
],
"isPush": true,
"release": {
"createdAt": "2026-04-22T16:58:12.365Z",
"dependencies": [
null
],
"displayName": "string",
"id": "string",
"label": "string",
"latest": true,
"metadata": {
"autoDeploy": true,
"installationSize": 0,
"postInstallAction": {
"exePath": "string",
"type": "NONE",
"url": "string"
},
"totalSize": 0
},
"policies": [
{
"association": {
"releases": [
{
"projectName": "string",
"version": "string"
}
]
},
"createdAt": "string",
"description": "string",
"id": "string",
"isActive": true,
"name": "string",
"rule": {},
"type": "NONE",
"updatedAt": "string",
"version": 0
}
],
"projectId": 0,
"projectName": "string",
"releaseNotes": "string",
"releasedAt": "2026-04-22T16:58:12.366Z",
"size": 0,
"status": "start",
"type": "NONE",
"updatedAt": "2026-04-22T16:58:12.366Z",
"version": "string"
}
}
],
"restrictions": [
{
"createdAt": "string",
"description": "string",
"id": "string",
"isActive": true,
"name": "string",
"rule": {},
"type": "string",
"updatedAt": "string",
"version": 0
}
]
}
Bad request
Internal server error