List Feeds

Modified on July 26, 2024

List Feeds is available as both a pgutil command and an HTTP Request, and will return an array of ProgetFeed objects, describing all existing feeds.

pgutil feeds list

Command Specification (CLI)

The feeds list command is used to list all existing feeds.

Listing all feeds does not require any additional options:

pgutil feeds list

This will return a list of feeds:

approved-nuget (nuget)
approved-pypi (pypi)
assets (asset)
public-debian (debian)
public-gems (rubygems)
unapproved-nuget (nuget)
unapproved-pypi (pypi)

HTTP Request Specification

To list all existing feeds, simply GET to the URL with an appropriate API Key.

GET /api/management/feeds/list

HTTP Response Specification

A successful (200) response body will contain an array of ProgetFeed objects. For example:

GET /api/management/feeds/list

[
    {
       "name":"myNugetFeed",
       "alternateNames":[],
       "feedType":"nuget",
       "active":true,
       "cacheConnectors":true,
       "symbolServerEnabled":false,
       "stripSymbols":false,
       "stripSource":false,
       "endpointUrl":"https://proget.corp.local/nuget/public-nuget/v3/index.json",
       "connectors":["nuget.org"],
       "retentionRules":[],
       "variables":{},
       "canPublish":true,
       "packageStatisticsEnabled":false,
       "restrictPackageStatistics":false,
       "deploymentRecordsEnabled":true,
       "usageRecordsEnabled":true,
       "vulnerabilitiesEnabled":true,
       "licensesEnabled":true,
       "useWithProjects":true
    },
    { ... } // remaining feeds
]

Sample Usage Scripts

List all feeds (Powershell)

This script will print a list of all existing feeds and their feed types.

$apiUrl = "https://proget.corp.local/api/management/feeds/list"
$apiKey = "abc12345"

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

$response = Invoke-RestMethod -Uri $apiUrl -Method Get -Headers $headers

foreach ($feed in $response) {
    $feedName = $feed.name
    $feedType = $feed.feedType
    $formattedFeed = "{0} ({1})" -f $feedName, $feedType
    Write-Host $formattedFeed
}

Example Output:

internal-npm (npm)
nuget-approved (nuget)
nuget-unapproved (nuget)
public-files (asset)
public-npm (npm)
universal-feed (universal)