Skip to main content

Get a specific release by catalog_id across CDN-connected devices

GET 
/api/cdn/device/releases/:catalog_id

Returns one entry per CDN-connected device that has the given catalog_id. By default returns only active devices (?device_status=active). Use ?device_mode=orchestrated, ?device_mode=reactive, or ?device_mode=both to filter by device flags. When ?device_mode= is set, add ?device_connectivity=online or ?device_connectivity=offline to further filter by heartbeat TTL.

Request​

Path Parameters

    catalog_id stringrequired

    Catalog ID of the release (e.g. "5.GetAppAgent-UI_linux_rpm@0.3.14").

Query Parameters

    device_id string[]

    Repeated device ID filter: ?device_id=id1&device_id=id2. Omit to return all.

    device_status any

    Device status filter: active (default), inactive, or all.

    device_mode any

    Device mode filter: orchestrated (ORCHESTRATE_ME flag), reactive (REACTIVE_MODE flag), or both. Omit for no mode filter.

    device_connectivity any

    Device connectivity filter (only applied when ?device_mode= is set): online (active SSE subscription on ManagedCommand channel), offline (not subscribed), or both.

Responses​

The specific release per device. Empty array if no device has this catalog_id — not 404.

Schema

  • Array [

    • data

    object

    required

    DTO for device release status including delivery, deploy, and installation information

    artsDirPath stringnullable

    Artifacts folder path

    deliveryState object

    deviceReleaseStatus

    object

    nullable

    Status enum that can be either a delivery status or a deployment status

    oneOf

    string

    downloadDuration int32nullable

    Download duration in seconds (for delivery state)

    downloadable booleannullable

    Whether the connected server has this release available for download to this device. Only present while the release is still in the Delivery (downloading) state.

    errMsg stringnullable

    Error message if any error occurred

    eta int64nullable

    Estimated time remaining in seconds

    hideIfNotHealthy booleannullable

    Whether this release should be hidden from the UI when its health check is offline

    online booleannullable

    Health status of this release (true = online, false = offline). Only present for installed releases that have a healthCheckUrl configured.

    progress floatnullable

    Progress percentage (0-100)

    release

    object

    required

    applicationCategory stringnullable

    Application category (user or technician)

    createdAt date-timerequired
    dependencies undefined[]nullable
    displayName stringnullable

    Human-readable display name of the project

    id stringrequired
    label stringnullable

    Label associated with the project

    latest booleannullable
    metadata objectnullable
    policies undefined[]nullable

    Policies associated with this release

    projectId int32required
    projectName stringrequired
    projectTypeV2 stringnullable

    The actual project type, regardless of agent compatibility

    releaseNotes stringnullable
    releasedAt date-timenullable
    size int64nullable
    status Statusrequired

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

    tagline stringnullable

    Short one-line summary of the project

    tags string[]nullable

    Tags of the project

    type Typerequired

    Possible values: [product, formation]

    updatedAt date-timerequired
    version stringrequired
    state DeviceReleaseStaterequired

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

    Represents the state of a release on the device Only covers delivery state and beyond — Offering/Push are not exposed on this endpoint

    dataWarning stringnullable

    Warning message indicating the data field may be incomplete or unreliable. When present, surface it visibly to the user.

    deviceId stringrequired

    Device identifier — matches the deviceId in CDN discovery.

    isMaster booleanrequired

    true when this entry represents the local CDN master agent itself.

    isOnline booleanrequired

    true when the device has an active SSE subscription on the ManagedCommand channel.

  • ]

Loading...