Skip to main content

Get release status by catalog ID

GET 
/api/v2/device/releases/:catalog_id

Retrieves the installation status for a specific software release on the root device. Returns delivery progress, deployment status, and current installation state. Only accessible for components in delivery state or beyond.

Request​

Path Parameters

    catalog_id stringrequired

    Catalog ID of the release

Responses​

Schema

    catalogId stringrequired
    latest booleannullable
    metadata nullable
    name stringrequired
    releaseAt date-timenullable
    releaseNotes stringnullable
    size int64required
    version stringrequired
    deliveryState DeliveryStatenullable

    Possible values: [prepare, download, validation, done]

    downloadDuration int32nullable

    Download duration in seconds (for delivery state)

    errMsg stringnullable

    Error message if any error occurred

    eta int64nullable

    Estimated time remaining in seconds

    progress floatnullable

    Progress percentage (0-100)

    state DeviceReleaseStaterequired

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

    Represents the state of a release on the device Subset of DeviceComponentState containing only Delivery state and greater

    status

    object

    nullable

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

    oneOf

    string

Loading...