Skip to main content

Download Agent Artifacts

Agent artifact downloads are redirect endpoints. They do not return JSON bodies. Instead, they return 302 Found with a Location header pointing to the actual installer artifact.

Use these endpoints when the consumer needs a stable API-owned download URL while allowing the backend to change the underlying storage location or issue signed URLs later.

Endpoints

EndpointMethodDescription
Download Latest ArtifactGETRedirect to the artifact for the current release in a channel
Download Versioned ArtifactGETRedirect to the artifact for a specific published version

Download Latest Artifact

GET /agent-releases/latest/download

Redirects to the installer artifact for the current release in the requested channel.

Query Parameters

ParameterTypeDefaultDescription
channelstringstableRelease stream to resolve: stable, latest
platformstring-Target platform: windows, macos
archstring-Required when platform=macos. Allowed values: arm64, x86_64

Example Requests

curl -I "https://api.example.com/v2/agent-releases/latest/download?channel=stable&platform=windows" \
-H "Authorization: Bearer YOUR_API_TOKEN"
curl -I "https://api.example.com/v2/agent-releases/latest/download?channel=stable&platform=macos&arch=arm64" \
-H "Authorization: Bearer YOUR_API_TOKEN"

Example Response

HTTP/1.1 302 Found
Location: https://downloads.example.com/agent/macos/arm64/latest/ScalepadAgent.pkg

Download Versioned Artifact

GET /agent-releases/{version}/download

Redirects to the installer artifact for the requested published version.

Path Parameters

ParameterTypeDescription
versionstringPublished release version

Query Parameters

ParameterTypeDefaultDescription
platformstring-Target platform: windows, macos
archstring-Required when platform=macos. Allowed values: arm64, x86_64

Example Requests

curl -I "https://api.example.com/v2/agent-releases/1.8.3/download?platform=windows" \
-H "Authorization: Bearer YOUR_API_TOKEN"
curl -I "https://api.example.com/v2/agent-releases/1.8.3/download?platform=macos&arch=x86_64" \
-H "Authorization: Bearer YOUR_API_TOKEN"

Example Response

HTTP/1.1 302 Found
Location: https://downloads.example.com/agent/windows/1.8.3/ScalepadAgent-1.8.3.msi

Error Responses

StatusDescription
400Invalid query parameters or invalid platform / arch combination
401Authentication required
403Insufficient permissions
404Agent release or artifact not found
500Server error

Example Error Response

{
"error": {
"code": "not_found",
"message": "Agent artifact not found",
"details": {
"version": "1.8.3",
"platform": "macos",
"arch": "x86_64"
}
}
}