Skip to main content

Get Device softwares

GET 
/api/v1/device/:deviceId/softwares

This service message allows retrieval of all software on a process in a given device.

Request​

Path Parameters

    deviceId stringrequired

Query Parameters

    ignoreCache boolean

    When true, bypasses the offering cache and fetches data directly from the offering service

    deduplicatePolicies boolean

    When true, policies are returned in a separate top-level list (allPolicies) and each software only contains policy IDs (policyIds) instead of full policy objects

Responses​

Schema

    id stringrequired
    lastUpdatedDate date-time
    lastConnectionDate date-time
    name string
    OS string
    availableStorage string
    power number
    bandwidth number
    operativeState boolean
    state string

    Possible values: [online, active, offline, disconnected]

    Connectivity state, computed at read-time: online > active > offline > disconnected.

    status string[]

    Possible values: [updating, error, restricted]

    Operational conditions; a device may have several at once (updating/error/restricted).

    online boolean

    True when the device currently holds an open reactive (managed-command) SSE channel.

    metaData object
    groupName string
    groupId number
    uid string
    formations string[]
    platformName string
    platformTypeName string

    The device's platform type name (server-derived from the platform_type catalog).

    deviceTypeName string
    devices string[]
    platformId string

    Platform instance id reported by the agent.

    softwares

    object[]

    required

  • Array [

    • software

    object

    required

    id stringrequired
    version stringrequired
    projectId integerrequired
    projectName stringrequired
    displayName string

    Human-readable display name of the project

    label string

    Label associated with the project

    applicationCategory string

    Application category (user or technician)

    tags string[]

    Tags of the project

    tagline string

    Short one-line summary of the project

    releaseNotes string

    metadata

    object

    autoDeploy boolean

    Enable automatic deployment of this release

    postInstallAction

    object

    Post-installation action configuration

    type stringrequired

    Possible values: [NONE, WEB, EXE]

    Action type: NONE (no action), WEB (open URL), or EXE (run executable)

    url string

    URL to open (required when type is WEB)

    exePath string

    Executable path to run (required when type is EXE)

    installationSize int64

    Installation size in bytes - disk space required after installation (user-specified)

    totalSize int64

    Total size in bytes - automatically calculated as installationSize + artifactsSize

    hideIfNotHealthy boolean

    Hide this release from agents if the health check URL is not healthy

    healthCheckUrl string

    URL to check for health status. Required when hideIfNotHealthy is true.

    healthCheckIntervalSeconds integer

    Interval in seconds between health check requests. Required when healthCheckUrl is set.

    timeoutInstallation int64

    Timeout installation in minutes (user-specified)

    deployV2

    object

    Deploy/V2 authored plan (tasks + agent rule). Persisted verbatim for lossless re-edit; the agent consumes the generated install.yaml, not this.

    property name* any

    Deploy/V2 authored plan (tasks + agent rule). Persisted verbatim for lossless re-edit; the agent consumes the generated install.yaml, not this.

    deployMethod string

    Possible values: [v1, v2]

    Deploy method the release supports (v2 = install.yaml orchestration). Lets consumers detect it without reading artifacts.

    supportedActions string[]

    Deploy/V2: the actions the agent exposes for this release (mirrors install.yaml Actions).

    repeatableActions string[]

    Deploy/V2: the supported actions that re-run on every call (default: all except install and uninstall; install.yaml Repeatable overrides).

    status stringrequired

    Possible values: [draft, in_review, approved, released, archived, error]

    type stringdeprecated

    Possible values: [product, application, lib, bundle, infra, config, config_map]

    projectTypeV2 string

    Possible values: [product, application, lib, bundle, infra, config, config_map]

    The actual project type, regardless of agent compatibility

    size int64
    createdAt date-timerequired
    updatedAt date-timerequired
    latest boolean
    releasedAt date-time
    dependencies undefined[]

    policies

    object[]

    Policies associated with this release

  • Array [

    • id stringrequired

    Policy rule ID

    name stringrequired

    Policy name

    description string

    Policy description

    type stringrequired

    Possible values: [policy, restriction]

    Policy type

    association

    object

    releases

    object[]

    Associated releases for policies

  • Array [

    • projectName stringrequired

    Project name

    version stringrequired

    Release version

  • ]

    • version numberrequired

    Policy version number

    createdAt stringrequired

    Policy creation timestamp

    updatedAt stringrequired

    Policy last update timestamp

    isActive booleanrequired

    Whether the policy is active

    isPush boolean

    Default value: false

    Whether this policy should be pushed to agents

    rule objectrequired

    The policy rule definition conforming to rule engine schema

  • ]

    • policyIds string[]

    Policy IDs associated with this release. Present when deduplicatePolicies flag is set to true.

    state string

    Possible values: [offering, push, delivery, downloaded, deleted, deploy, installed, uninstalled]

    downloadDate date-time
    deployDate date-time

    offering

    object[]

    required

  • Array [

    • id stringrequired
    version stringrequired
    projectId integerrequired
    projectName stringrequired
    displayName string

    Human-readable display name of the project

    label string

    Label associated with the project

    applicationCategory string

    Application category (user or technician)

    tags string[]

    Tags of the project

    tagline string

    Short one-line summary of the project

    releaseNotes string

    metadata

    object

    autoDeploy boolean

    Enable automatic deployment of this release

    postInstallAction

    object

    Post-installation action configuration

    type stringrequired

    Possible values: [NONE, WEB, EXE]

    Action type: NONE (no action), WEB (open URL), or EXE (run executable)

    url string

    URL to open (required when type is WEB)

    exePath string

    Executable path to run (required when type is EXE)

    installationSize int64

    Installation size in bytes - disk space required after installation (user-specified)

    totalSize int64

    Total size in bytes - automatically calculated as installationSize + artifactsSize

    hideIfNotHealthy boolean

    Hide this release from agents if the health check URL is not healthy

    healthCheckUrl string

    URL to check for health status. Required when hideIfNotHealthy is true.

    healthCheckIntervalSeconds integer

    Interval in seconds between health check requests. Required when healthCheckUrl is set.

    timeoutInstallation int64

    Timeout installation in minutes (user-specified)

    deployV2

    object

    Deploy/V2 authored plan (tasks + agent rule). Persisted verbatim for lossless re-edit; the agent consumes the generated install.yaml, not this.

    property name* any

    Deploy/V2 authored plan (tasks + agent rule). Persisted verbatim for lossless re-edit; the agent consumes the generated install.yaml, not this.

    deployMethod string

    Possible values: [v1, v2]

    Deploy method the release supports (v2 = install.yaml orchestration). Lets consumers detect it without reading artifacts.

    supportedActions string[]

    Deploy/V2: the actions the agent exposes for this release (mirrors install.yaml Actions).

    repeatableActions string[]

    Deploy/V2: the supported actions that re-run on every call (default: all except install and uninstall; install.yaml Repeatable overrides).

    status stringrequired

    Possible values: [draft, in_review, approved, released, archived, error]

    type stringdeprecated

    Possible values: [product, application, lib, bundle, infra, config, config_map]

    projectTypeV2 string

    Possible values: [product, application, lib, bundle, infra, config, config_map]

    The actual project type, regardless of agent compatibility

    size int64
    createdAt date-timerequired
    updatedAt date-timerequired
    latest boolean
    releasedAt date-time
    dependencies undefined[]

    policies

    object[]

    Policies associated with this release

  • Array [

    • id stringrequired

    Policy rule ID

    name stringrequired

    Policy name

    description string

    Policy description

    type stringrequired

    Possible values: [policy, restriction]

    Policy type

    association

    object

    releases

    object[]

    Associated releases for policies

  • Array [

    • projectName stringrequired

    Project name

    version stringrequired

    Release version

  • ]

    • version numberrequired

    Policy version number

    createdAt stringrequired

    Policy creation timestamp

    updatedAt stringrequired

    Policy last update timestamp

    isActive booleanrequired

    Whether the policy is active

    isPush boolean

    Default value: false

    Whether this policy should be pushed to agents

    rule objectrequired

    The policy rule definition conforming to rule engine schema

  • ]

    • policyIds string[]

    Policy IDs associated with this release. Present when deduplicatePolicies flag is set to true.

  • ]

    • error string
    isUnknown boolean

    Indicates if this version is unknown (not registered in getapp)

    action string

    Possible values: [offering, push]

    How this software was offered to the device. "offering" = automatically available, "push" = explicitly pushed by an admin. Undefined if the software was unpushed or was never directly offered/pushed to this device.

    progress number

    Real per-device progress (0-100) for this component: delivery/download % while downloading, deploy/install % once in the deploy phase. Undefined when no active percentage exists (e.g. push/downloaded/offering) — clients should render an indeterminate bar rather than 0%.

  • ]

    • allPolicies

    object[]

    Deduplicated list of all policies across all softwares. Present only when deduplicatePolicies query param is set to true.

  • Array [

    • id stringrequired

    Policy rule ID

    name stringrequired

    Policy name

    description string

    Policy description

    type stringrequired

    Possible values: [policy, restriction]

    Policy type

    association

    object

    releases

    object[]

    Associated releases for policies

  • Array [

    • projectName stringrequired

    Project name

    version stringrequired

    Release version

  • ]

    • version numberrequired

    Policy version number

    createdAt stringrequired

    Policy creation timestamp

    updatedAt stringrequired

    Policy last update timestamp

    isActive booleanrequired

    Whether the policy is active

    isPush boolean

    Default value: false

    Whether this policy should be pushed to agents

    rule objectrequired

    The policy rule definition conforming to rule engine schema

  • ]

Loading...