Download File Endpoint

The Download File is an endpoint in ProGet's Asset Directory API. It returns the file as content, allowing the file to be downloaded.

curl -X GET --header "X-ApiKey: abc12345" "https://proget.corp.local/endpoints/internal-files/content/log_data.bin" -o "C:\ProGet\log_data.bin"

Request Specification

To return the content a file, GET to the URL with the AssetDirectoryName and path to the file.

GET /endpoints/«AssetDirectoryName»/content/«path_to_file»

To return only the headers of an file, HEAD to the URL with the AssetDirectoryName and path to the file.

HEAD /endpoints/«AssetDirectoryName»/content/«path_to_file»

Requesting a .bin file's content within a folder requires the asset directory name (e.g. myAssetDirectory), the folder (e.g. myFolder) and the file name (e.g. mycontent.bin)

GET /endpoints/myAssetDirectory/content/myFolder/mycontent.bin

Response Specification

A successful (200) response to a GET or HEAD request will contain the file headers, for example, to a request of a file, mycontent.bin:

HEAD/GET /endpoints/myAssetDirectory/content/mycontent.bin

HTTP/1.1 200 OK
Content-Length: 5
Content-Type: application/octet-stream
Date: Fri, 08 Dec 2023 04:05:38 GMT
Server: Kestrel
Cache-Control: public
ETag: f7ff9e8b7bb2e09b70935a5d785e0cc5d9d0abf0
Last-Modified: Fri, 08 Dec 2023 03:58:11 GMT
Vary: Accept-Encoding, Authorization
X-ProGet-Version: 23.0.22.6

Sample Usage Scripts

Download all files in a folder (Powershell)

This script downloads all files within an asset directory, internal-files from a folder, download-files, to a local folder, C:\Proget\DownloadedFiles:

$baseUrl = "http://proget.corp.local"
$assetDirectory = "internal-files"
$assetFolder = "download-files"
$apiKey = "pra1b2c3d4e5oget"
$localFolder = "C:\ProGet\DownloadedFiles"

if (-not (Test-Path -Path $localFolder -PathType Container)) {
    New-Item -Path $localFolder -ItemType Directory | Out-Null
}

$listApiEndpoint = "$baseUrl/endpoints/$assetDirectory/dir/$assetFolder" + "?recursive=false"
$downloadApiEndpoint = "$baseUrl/endpoints/$assetDirectory/content/$assetFolder/"

$headers = @{"X-ApiKey" = $apiKey}

function Download-File {
    param (
        [string]$fileUrl,
        [string]$localFilePath
    )

    try {
        Invoke-WebRequest -Uri $fileUrl -OutFile $localFilePath -Headers $headers -ErrorAction Stop
        Write-Host "Downloaded: $($localFilePath | Split-Path -Leaf)"
    } catch {
        Write-Host "Failed to download: $($localFilePath | Split-Path -Leaf). $_"
    }
}

try {
    $listResponse = Invoke-RestMethod -Uri $listApiEndpoint -Method Get -Headers $headers

    if ($listResponse.Count -gt 0) {
        foreach ($fileInfo in $listResponse) {
            $fileName = $fileInfo.name
            $fileDownloadUrl = $fileInfo.content
            $completeDownloadUrl = $downloadApiEndpoint + $fileName
            $localFilePath = Join-Path $localFolder $fileName
            Download-File -fileUrl $completeDownloadUrl -localFilePath $localFilePath
        }

        Write-Host "All files downloaded successfully."
    } else {
        Write-Host "The folder is empty"
    }
} catch {
    Write-Host "Failed to retrieve the list of files. $_"
}