Internet Explorer is no longer supported. Many things will still work, but your experience will be degraded and some things won't function. Please use a modern browser such as Edge, Chrome, or Firefox.

Get Feed

Modified on July 26, 2024view on GitHub

Get Feed is available as both a pgutil command and an HTTP Request, and will return a single ProgetFeed object or a list of properties for the specified feed.

Command Specification (CLI)

The feeds properties list command is used to return properties of a single feed.

The --feed option is always required.

Getting a feed requires the feed name (e.g. myNugetFeed):

pgutil feeds properties list --feed=myNugetFeed

This will return properties of the specified feed:

alternateNames=*not set*
feedType=nuget
active=true
dropPath=*not set*
endpointUrl=https://proget.corp.local/nuget/myNugetFeed/v3/index.json
connectors=nuget.org
canPublish=true
vulnerabilitiesEnabled=true

HTTP Request Specification

To return a specified feed, simply GET to the URL with the name of the feed and an appropriate API Key.

GET /api/management/feeds/get/«feed-name»

HTTP Response Specification

A successful (200) response body will contain a single ProgetFeed object. For example, to requesting a feed with the name myNugetFeed, the request would return:

GET /api/management/feeds/get/myNugetFeed

{
   "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
}
Response Details
200 (Success) body will contain a ProgetFeed object
400 (Invalid Input) indicates invalid or missing properties in the request; the body will provide some details as text
403 (Unauthorized API Key) indicates a missing, unknown, or unauthorized API Key; the body will be empty
404 (Feed Not Found) indicates that the specified feed does not exist