List Universal Packages

List Universal Packages is an endpoint in ProGet's Universal Feed API that will return either PackageData JSON object (if name is specified) or a JSON array of objects, depending on parameters defined.

curl -X GET --header "X-ApiKey: abc12345" "https://proget.corp.local/upack/myUniversalFeed/packages?group=myGroup&name=myUniversalPackage"

Parameter Description

Request Specification

To list a package, simply GET to the URL with one or more parameters.

GET /upack/«feed-name»/packages?group=«group»&name=«name»&count=«count»

Listing a package version requires the feed (e.g. myUniversalFeed) and package name (e.g. myUniversalPackage):

GET /upack/myUniversalFeed/packages?name=myUniversalPackage

Listing all packages with a package count specified requires the feed (e.g. myUniversalFeed) and count (e.g. 50):

GET /upack/myUniversalFeed/packages?count=50

Note that the group parameter must be a full match; future versions of this endpoint may allow for a sub-group searching (such as groupName*) if anyone requests.

Response Specification

A successful (200) response body will contain either a PackageData JSON object (if name is specified) or a JSON array of objects. For example:

When querying with no parameters, the request would return:

GET /upack/myUniversalFeed/packages

[
  {
    "group": "MyGroup",
    "name": "MyUniversalPackage",
    "latestVersion": "2.0.4",
    "title": "Test Package",
    "description": "Test Package for API Documentation",
    "downloads": "5",
    "isLocal": true,
    "isCached": false,
    "versions": ["2.0.4", "1.2.3", "1.0.0"]
  },
  { ... } // other packages
]

When querying a package by specifying a group (e.g. MyGroup) and/or name (e.g. MyUniversalPackage), the request returns:

GET /upack/myUniversalFeed/packages?group=myGroup&name=myUniversalPackage

{
  "group": "MyGroup",
  "name": "MyUniversalPackage",
  "latestVersion": "2.0.4",
  "title": "Test Package",
  "description": "Test Package for API Documentation",
  "downloads": "5",
  "isLocal": true,
  "isCached": false,
  "versions": ["2.0.4", "1.2.3", "1.0.0"]
}