Skip to main content
API Explorer|API Explorer
Infrastructure/Installer
GETInstallerSince 1.0SynchronousAuth Required

GetPackageDownloadProgress

Get download progress information for a specific package by name

Execution Availability

Try It Out

Submit a mock request using the current auth context and example-driven inputs.

Path Parameters

Request Inputs

Path Parameters

  • nameStringRequired

    Name of the package to retrieve download progress for

Responses

200 OK

On success, this API returns the following response structure.

  • packageNameString

    Name of the package being downloaded

    Example: zcf-core

  • statusString

    Current status of the download job

    Example: in_progress

  • progressInteger

    Download progress as a percentage from 0 to 100

    Example: 67

  • sizeMbString

    Total size of the package in megabytes

    Example: 256

  • startedAtString

    Started at

    Example: 2026-01-15T08:00:00Z

  • completedAtString

    Completed at

    Example: 2026-01-15T08:00:00Z

Endpoint

GET/api/v1/installer/packages/{name}/progress

/api/v1/installer/packages/{name}/progress

Operation ID

GetPackageDownloadProgress

Permalink

Request Example

curl -X GET '{host}/api/v1/installer/packages/{name}/progress' -H 'Authorization: Bearer {token}'

Response Example

200
{
  "packageName": "zcf-core",
  "status": "in_progress",
  "progress": 67,
  "sizeMb": 256,
  "startedAt": "example",
  "completedAt": "example"
}

Change History

This API has no change history records yet.

View all change history