Skip to main content

Set component's deployment status

POST 
/devices/:device_id/component/:catalog_id/deploy

This endpoint allows updating the deployment status of a component on a device.

Request​

Path Parameters

    device_id stringrequired

    ID of the device to retrieve components for

    catalog_id stringrequired

    Catalog ID of the component to retrieve

Body

required

    estimateTime int64nullable
    eventTime date-timenullable

    The time when the deployment event occurred (stopped, started, etc.)

    messageLog stringnullable
    progress int32nullable

    Possible values: <= 100

    status object

Responses​

Schema

    catalogId stringrequired
    completedAt date-timenullable
    currentTime date-timenullable
    deviceId stringrequired
    eta int64nullable
    messageLog stringnullable
    progress int32nullable
    requestedStatus object
    startedAt date-timenullable
    status object
    stoppedAt date-timenullable
    type ItemTyperequired

    Possible values: [software, map, cache]

Loading...