Upload Package Endpoint

Upload Package is an endpoint in ProGet's Universal Feed API that will add or replace a package in a feed.

There are quite a few ways to access this endpoint, but the end result is the same. Because there are so many permutations of how you can use this, it's easiest to specify the various options and behaviors instead.

First and foremost, consider that a complete package consists of required metadata and content (arbitrary files and directories). This endpoint is designed to allow you to upload a complete, pre-built package, or upload a partial package with content and metadata you specified using path, query, form-encoded, and/or JSON parameters.

curl -X POST -H "Content-Type: application/zip" --header "X-ApiKey: abc12345" --data-binary "@C:\Proget\MyUniversalPackage-1.2.3.upack" "https://proget.corp.local/upack/universal-feed/upload"

Content Type

The Content-Type header can be any of the following:

• application/json - properties on the JSON object will be used for content and metadata parameters
• application/x-www-form-urlencoded - the key/value pairs will be used for content and metadata parameters
• application/zip - the request body will treated either as content or a partial package

Parameter Description

Any of the following parameters fields may be specified through querystring or content; the format must follow a valid metadata format specification.

Request Specification

To upload a package, simply POST to the URL with a feed name and a JSON object in the body.

POST /upack/«feed-name»/upload

Uploading a Universal Package requires the feed name (e.g. myUniversalFeed):

POST /endpoints/myAssetDirectory/import/myFolder?format=zip&overwrite=true

«contents of myUniversalPackage-1.2.3.upack»

Response Specification

Sample Usage Scripts

Bulk upload of all packages (PowerShell)

This script will upload all .upack packages from the local folder C:\ProGet\Package Uploads, to the universal feed universal-uploads:

$apiKey = "a1b2c3d4e5"
$directoryPath = "C:\ProGet\Package Uploads"
$uploadUrl = "https://proget.corp.local/upack/universal-uploads/upload"

$headers = @{
    "Content-Type" = "application/zip"
    "X-ApiKey" = $apiKey
}

$filePaths = Get-ChildItem -Path $directoryPath | Where-Object { $_.Extension -match '\.upack$' } | Select-Object -ExpandProperty FullName

if ($filePaths.Count -eq 0) {
    Write-Host "No files found in $directoryPath"
} else {
    foreach ($filePath in $filePaths) {
      Write-Host "Uploading file: $filePath"
      
      $response = Invoke-RestMethod -Uri $uploadUrl -Method Post -Headers $headers -InFile $filePath -ContentType "application/zip"
      
      Write-Host ("Response for $($filePath):")
      $response
    }
}

Bulk Upload of all versions of a package (PowerShell)

This script will upload all versions of the BaseModules package from the local folder C:\ProGet\Package Uploads, to the universal feed universal-uploads:

$apiKey = "a1b2c3d4e5"
$directoryPath = "C:\ProGet\Package Uploads"
$uploadUrl = "https://proget.corp.local/upack/universal-uploads/upload"
$specifiedPackageName = "BaseModules"

$headers = @{
    "Content-Type" = "application/zip"
    "X-ApiKey" = $apiKey
}

$filePaths = Get-ChildItem -Path $directoryPath | Where-Object { 
    $_.Extension -eq '.upack' -and $_.BaseName -like "$specifiedPackageName*" 
} | Select-Object -ExpandProperty FullName

if ($filePaths.Count -eq 0) {
    Write-Host "No files found in $directoryPath with the specified package name."
} else {
    foreach ($filePath in $filePaths) {
        Write-Host "Uploading file: $filePath"
        
        $response = Invoke-RestMethod -Uri $uploadUrl -Method Post -Headers $headers -InFile $filePath -ContentType "application/zip"
        
        Write-Host ("Response for $($filePath):")
        $response
    }
}