Update Feed

Modified on July 26, 2024

Update Feed is available as both a pgutil command and an HTTP Request, and will update a specified feed using the Feed object properties defined in the request body. This endpoint supports partial updating by only updating the properties that are supplied in the request.

pgutil feeds properties set --feed=myNugetFeed --property=dropPath --value=c:\bulk-import

Command Specification (CLI)

The feeds properties set command is used to update properties of a single feed.

The --property and --value options are always required. The --feed option is required if there is no default feed configured. The following properties can be set with this command:

Updating a feed's drop path requires the feed name (e.g. myNugetFeed), the property to be updated (e.g. dropPath), and the value to update this with (e.g. c:\bulk-import):

pgutil feeds properties set --feed=myNugetFeed --property=dropPath --value=c:\bulk-import

Adding multiple connectors to a feed requires the feed name (e.g. myFeed), the property to be updated (e.g. connectors), and the name of the connectors (e.g. registry.npmjs.org and nuget.org):

pgutil feeds properties set --feed=myFeed --property=connectors --value=registry.npmjs.org,nuget.org

Disabling a feed requires the feed name (e.g. myPypiFeed), the property to be updated (e.g. active), and the value to update this with (e.g. false):

pgutil feeds properties set --feed=myPypiFeed --property=active --value=false

Updating Retention Rules

The feeds retention commands are used to update a feed's retention rules.

There are four commands available (create, list, update, and delete), and each command has options that correspond to fields in the web UI. The --feed option is required in all commands if there is no default feed configured. The --rule option is required for the update and delete commands, and corresponds to the rule number, identified using the list command. (see example)

The following options are used with the create, update, anddelete commands:

Creating a retention rule for a feed requires the feed name (e.g. myNugetFeed) and the retention rule to be created (e.g. --deletePrereleaseVersions as true):

pgutil feeds retention create --feed=myNugetFeed --deletePrereleaseVersions=true

Listing a feed's retention rules requires the feed name (e.g. myPypiFeed):

pgutil feeds retention list --feed=myPypiFeed

Example output of listing retention rules:

[1]
 deleteCached=true
 deletePackageIds=*not set*
 deletePrereleaseVersions=false
 deleteVersions=*not set*
 keepConsumedWithinDays=*not set*
 keepIfActivelyConsumed=false
 keepPackageIds=*not set*
 keepPackageUsageRemovedDays=*not set*
 keepUsedWithinDays=*not set*
 keepVersionsCount=*not set*
 sizeExclusive=false
 sizeTrigger=*not set*
 triggerDownloadCount=*not set*
[2]
 deleteCached=false
 deletePackageIds=*not set*
 deletePrereleaseVersions=true
 deleteVersions=*not set*
 keepConsumedWithinDays=*not set*
 keepIfActivelyConsumed=false
 keepPackageIds=*not set*
 keepPackageUsageRemovedDays=*not set*
 keepUsedWithinDays=*not set*
 keepVersionsCount=*not set*
 sizeExclusive=false
 sizeTrigger=*not set*
 triggerDownloadCount=*not set*

Updating retention rules for a feed requires the feed name (e.g. myNugetFeed), the existing retention rule (e.g. 1), and the properties to be updated (e.g. deleteCached as true and keepVersionsCount as 5, and keepUsedWithinDays as blank to revert it to not-set):

pgutil feeds retention update --feed=myNugetFeed --deleteCached=true --keepVersionsCount=5 --keepUsedWithinDays= --rule=1

Example update (Before):

 deleteCached=false
 deletePackageIds=*not set*
 deletePrereleaseVersions=false
 deleteVersions=*not set*
 keepConsumedWithinDays=*not set*
 keepIfActivelyConsumed=false
 keepPackageIds=*not set*
 keepPackageUsageRemovedDays=*not set*
 keepUsedWithinDays=30
 keepVersionsCount=*not set*
 sizeExclusive=false
 sizeTrigger=*not set*
 triggerDownloadCount=*not set*

Example update (After):

 deleteCached=true
 deletePackageIds=*not set*
 deletePrereleaseVersions=false
 deleteVersions=*not set*
 keepConsumedWithinDays=*not set*
 keepIfActivelyConsumed=false
 keepPackageIds=*not set*
 keepPackageUsageRemovedDays=*not set*
 keepUsedWithinDays=*not set*
 keepVersionsCount=5
 sizeExclusive=false
 sizeTrigger=*not set*
 triggerDownloadCount=*not set*

Deleting a retention rule for a feed requires the feed name (e.g. myNpmFeed) and the retention rules number (e.g. 4) from the list command:

pgutil feeds retention delete --feed=myNpmFeed --rule=4

HTTP Request Specification

To update a feed, simply POST to the URL with the feed name, an appropriate API Key and a Feed object as the request body.

POST /api/management/feeds/update/«feed-name»

HTTP Response Specification

A successful (200) response body will contain an updated Feed object. For example, when updating a NuGet feed myNugetFeed with a new description, this returns:

{
  "name": "myNugetFeed",
  "alternateNames": [],
  "feedType": "nuget",
  "description": "This feed serves as a proxy for Inedo SDK extensions.",
  "active": true,
  "cacheConnectors": true,
  "allowUnknownLicenses": true,
  "allowedLicenses": [],
  "blockedLicenses": [],
  "symbolServerEnabled": false,
  "stripSymbols": false,
  "stripSource": false,
  "endpointUrl": "http://proget.corp.local/nuget/nuget/v3/index.json",
  "connectors": ["nuget.org", "proget.connector.local"],
  "vulnerabilitySources": [],
  "retentionRules": [],
  "packageFilters": {},
  "packageAccessRules": {},
  "variables": {},
  "canPublish": true,
  "packageStatisticsEnabled": false,
  "restrictPackageStatistics": false,
  "deploymentRecordsEnabled": true,
  "usageRecordsEnabled": true,
  "vulnerabilitiesEnabled": false,
  "licensesEnabled": false,
  "useWithProjects": true
}

Sample Usage Scripts

Add a connector to a feed (Powershell)

This script will add a connector nuget.org, to a feed nuget-unapproved. If the specified connector already exists, no changes will be made.

Only connectors that already exist in the ProGet instance may be added. See the Create Connector endpoint to add a new connector.

This script can be edited to work with other Feed object properties that are array types.

$baseUrl = "https://proget.corp.local"
$apiKey = "a1b2c3d4e5"
$feedName = "nuget-unapproved"
$key = "connectors"
$newFeedValue = "nuget.org"

function Get-FeedInfo {
    param ([string]$feedName)
    $url = "$baseUrl/api/management/feeds/get/$($feedName)"
    $headers = @{"X-ApiKey" = $apiKey}
    $response = Invoke-RestMethod -Uri $url -Headers $headers -Method Get
    return $response
}

function Update-FeedInfo {
    param ([string]$feedName,[string]$newValue)
    $url = "$baseUrl/api/management/feeds/update/$($feedName)"
    $headers = @{"X-ApiKey" = $apiKey}
    $currentFeedInfo = Get-FeedInfo -feedName $feedName
    $keyToChange = $currentFeedInfo.$key

    if ($keyToChange -notcontains $newValue) {
        $keyToChange += $newValue
        $body = @{$key = $keyToChange}
        $response = Invoke-RestMethod -Uri $url -Headers $headers -Method Post -Body ($body | ConvertTo-Json) -ContentType "application/json"
        Write-Host "'$($newFeedValue)' added successfully to $($key)"
    } else {
        Write-Host "No changes needed. Value '$($newValue)' already exists in $($key)."
    }
}

Update-FeedInfo -feedName $feedName -newValue $newFeedValue

Delete a connector from a feed (Powershell)

This script will delete a connector nuget.org, from a feed nuget-unapproved. If the specified connector does not exist, no changes will be made.

This script can be edited to work with other Feed object properties that are array types.

$baseUrl = "https://proget.corp.local"
$feedName = "nuget-unapproved"
$apiKey = "a1b2c3d4e5"
$key = "connectors"
$valueToDelete = "nuget.org"

$feedUrl = "$baseUrl/api/management/feeds/get/$feedName"
$feedDetails = Invoke-RestMethod -Uri $feedUrl -Headers @{ "X-ApiKey" = $apiKey }

if ($feedDetails.$key -contains $valueToDelete) {
    $feedDetails.$key = $feedDetails.$key -ne $valueToDelete
    $updateData = @{$key = $feedDetails.$key}
    $updateUrl = "$baseUrl/api/management/feeds/update/$feedName"
    Invoke-RestMethod -Uri $updateUrl -Headers @{ "X-ApiKey" = $apiKey; "Content-Type" = "application/json" } -Method Post -Body ($updateData | ConvertTo-Json)

    Write-Host "Value '$valueToDelete' deleted from $key."
} else {
    Write-Host "Value '$valueToDelete' not found in $key. No changes made."
}