Trigger component discovery
POST/api/v2/triggers/discover-component
Triggers discovery of available components and offerings using the agent's current context. Returns matching component and software offers from the GetApp server.
Request
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 [
Array [
]
]
]
Array [
]
allPolicies
object[]
Deduplicated list of all policies across all releases. Present only when deduplicatePolicies flag is set to true. Each release will contain policyIds instead of full policy objects.
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
Whether this policy should be pushed to agents
Policy name
The policy rule definition conforming to rule engine schema
Possible values: [product, formation]
Policy last update timestamp
Policy version number
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.
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.
offer
object[]
required
deprecated
Use 'releases' field instead
Application category (user or technician)
Human-readable display name of the project
Label associated with the project
metadata
object
Enable automatic deployment of this release
Deploy method the release supports (v2 = install.yaml orchestration). Lets consumers detect it without reading artifacts.
Deploy/V2 authored plan (tasks + agent rule). Persisted verbatim for lossless re-edit; the agent consumes the generated install.yaml, not this.
Interval in seconds between health check requests. Required when healthCheckUrl is set.
URL to check for health status. Required when hideIfNotHealthy is true.
Hide this release from agents if the health check URL is not healthy
Installation size in bytes - disk space required after installation (user-specified)
postInstallAction
object
Executable path to run (required when type is EXE)
Possible values: [product, formation]
URL to open (required when type is WEB)
Deploy/V2: the supported actions that re-run on every call (default: all except install and uninstall; install.yaml Repeatable overrides).
Deploy/V2: the actions the agent exposes for this release (mirrors install.yaml Actions).
Timeout installation in minutes (user-specified)
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
Whether this policy should be pushed to agents
Policy name
The policy rule definition conforming to rule engine schema
Possible values: [product, formation]
Policy last update timestamp
Policy version number
Policy IDs associated with this release. Present when deduplicatePolicies flag is set to true.
The actual project type, regardless of agent compatibility
Possible values: [draft, in_review, approved, released, archived]
Short one-line summary of the project
Tags of the project
Possible values: [product, formation]
platform
object
Ids of the devices that belong to this platform (share the same platformId).
Device id acting as the master of this platform, when known.
Shared platform instance id.
Shared platform instance name (agent- or server-writable, resolved by last-writer-wins).
Platform type token (the value the agent reports for the platform type).
Platform unit (agent- or server-writable, resolved by last-writer-wins).
push
object[]
required
deprecated
Use 'releases' field instead
Application category (user or technician)
Human-readable display name of the project
Label associated with the project
metadata
object
Enable automatic deployment of this release
Deploy method the release supports (v2 = install.yaml orchestration). Lets consumers detect it without reading artifacts.
Deploy/V2 authored plan (tasks + agent rule). Persisted verbatim for lossless re-edit; the agent consumes the generated install.yaml, not this.
Interval in seconds between health check requests. Required when healthCheckUrl is set.
URL to check for health status. Required when hideIfNotHealthy is true.
Hide this release from agents if the health check URL is not healthy
Installation size in bytes - disk space required after installation (user-specified)
postInstallAction
object
Executable path to run (required when type is EXE)
Possible values: [product, formation]
URL to open (required when type is WEB)
Deploy/V2: the supported actions that re-run on every call (default: all except install and uninstall; install.yaml Repeatable overrides).
Deploy/V2: the actions the agent exposes for this release (mirrors install.yaml Actions).
Timeout installation in minutes (user-specified)
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
Whether this policy should be pushed to agents
Policy name
The policy rule definition conforming to rule engine schema
Possible values: [product, formation]
Policy last update timestamp
Policy version number
Policy IDs associated with this release. Present when deduplicatePolicies flag is set to true.
The actual project type, regardless of agent compatibility
Possible values: [draft, in_review, approved, released, archived]
Short one-line summary of the project
Tags of the project
Possible values: [product, formation]
releases
object[]
required
Components with all additional data of platform and device type hierarchy, project and actions
Indicates whether this release is available for delivery (true when release status is not error)
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
Application category (user or technician)
Display name of the project
ID of the project
Label of the project
Name of the project
Short one-line summary of the project
Tags 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
Array of managed device IDs that this release is pushed to
release
object
required
Application category (user or technician)
Human-readable display name of the project
Label associated with the project
metadata
object
Enable automatic deployment of this release
Deploy method the release supports (v2 = install.yaml orchestration). Lets consumers detect it without reading artifacts.
Deploy/V2 authored plan (tasks + agent rule). Persisted verbatim for lossless re-edit; the agent consumes the generated install.yaml, not this.
Interval in seconds between health check requests. Required when healthCheckUrl is set.
URL to check for health status. Required when hideIfNotHealthy is true.
Hide this release from agents if the health check URL is not healthy
Installation size in bytes - disk space required after installation (user-specified)
postInstallAction
object
Executable path to run (required when type is EXE)
Possible values: [product, formation]
URL to open (required when type is WEB)
Deploy/V2: the supported actions that re-run on every call (default: all except install and uninstall; install.yaml Repeatable overrides).
Deploy/V2: the actions the agent exposes for this release (mirrors install.yaml Actions).
Timeout installation in minutes (user-specified)
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
Whether this policy should be pushed to agents
Policy name
The policy rule definition conforming to rule engine schema
Possible values: [product, formation]
Policy last update timestamp
Policy version number
Policy IDs associated with this release. Present when deduplicatePolicies flag is set to true.
The actual project type, regardless of agent compatibility
Possible values: [draft, in_review, approved, released, archived]
Short one-line summary of the project
Tags of the project
Possible values: [product, formation]
restrictions
object[]
required
List of applicable restrictions for the device based on device ID, device type, OS, and other metadata
The restriction rule object
Possible values: [product, formation]
{
"allPolicies": [
{
"association": {
"releases": [
{
"projectName": "string",
"version": "string"
}
]
},
"createdAt": "string",
"description": "string",
"id": "string",
"isActive": true,
"isPush": true,
"name": "string",
"rule": {},
"type": "product",
"updatedAt": "string",
"version": 0
}
],
"configDeviceIds": [
"string"
],
"latestConfigSemVer": "string",
"platform": {
"devices": [
"string"
],
"masterDeviceId": "string",
"platformId": "string",
"platformName": "string",
"platformTypeToken": "string",
"unit": "string"
},
"releases": [
{
"available": true,
"dependedOnBy": [
"string"
],
"hierarchyTrees": [
{
"deviceTypes": [
{
"deviceTypeId": 0,
"deviceTypeName": "string",
"projectApplicationCategory": "string",
"projectDisplayName": "string",
"projectId": 0,
"projectLabel": "string",
"projectName": "string",
"projectTagline": "string",
"projectTags": [
"string"
]
}
],
"platformTypeId": 0,
"platformTypeName": "string"
}
],
"isPush": true,
"pushTo": [
"string"
],
"release": {
"applicationCategory": "string",
"createdAt": "2026-11-08T13:48:42.690Z",
"dependencies": [
null
],
"displayName": "string",
"id": "string",
"label": "string",
"latest": true,
"metadata": {
"autoDeploy": true,
"deployMethod": "v1",
"deployV2": {},
"healthCheckIntervalSeconds": 0,
"healthCheckUrl": "string",
"hideIfNotHealthy": true,
"installationSize": 0,
"postInstallAction": {
"exePath": "string",
"type": "product",
"url": "string"
},
"repeatableActions": [
"string"
],
"supportedActions": [
"string"
],
"timeoutInstallation": 0,
"totalSize": 0
},
"policies": [
{
"association": {
"releases": [
{
"projectName": "string",
"version": "string"
}
]
},
"createdAt": "string",
"description": "string",
"id": "string",
"isActive": true,
"isPush": true,
"name": "string",
"rule": {},
"type": "product",
"updatedAt": "string",
"version": 0
}
],
"policyIds": [
"string"
],
"projectId": 0,
"projectName": "string",
"projectTypeV2": "product",
"releaseNotes": "string",
"releasedAt": "2026-11-08T13:48:42.691Z",
"size": 0,
"status": "draft",
"tagline": "string",
"tags": [
"string"
],
"type": "product",
"updatedAt": "2026-11-08T13:48:42.691Z",
"version": "string"
}
}
],
"restrictions": [
{
"createdAt": "string",
"description": "string",
"id": "string",
"isActive": true,
"name": "string",
"rule": {},
"type": "product",
"updatedAt": "string",
"version": 0
}
]
}
Bad request
Internal server error