Skip to main content

Register or update an installed release with extended properties

PATCH 
/api/v2/device/releases/:catalog_id

Creates or updates a component identified by its catalog_id, marks it as installed, and stores provided metadata (health check URL, interval, display name, etc.). On double registration the second call merges — provided fields override, missing fields retain their current value. If a healthCheckUrl is provided, the agent immediately probes the app and stores its health status.

Request​

Path Parameters

    catalog_id stringrequired

    Catalog ID of the release to update

Body

required

    applicationCategory stringnullable

    Application category (e.g. "productivity", "utility")

    catalogId stringnullable

    Component catalog ID — alternative to name + version for identifying the component

    displayName stringnullable

    Human-readable display name for the component

    healthCheckIntervalSeconds int32nullable

    Interval in seconds between health probes (default: 30)

    healthCheckUrl stringnullable

    URL that the agent will probe to determine app health

    metadata nullable

    Additional metadata key-value pairs to merge into the component's metadata JSON

    name stringnullable

    Component name — used together with version to resolve the component when catalog_id is not provided

    online booleannullable

    Report whether the app is online (health self-report)

    version stringnullable

    Component version — used together with name to resolve the component when catalog_id is not provided

Responses​

Release registered/updated

Loading...