Universal Feed API

Like the package format, the Universal Feed API was designed with simplicity in mind. Because universal packages are designed to be consumed by any language or platform, the API offers several different ways to do the same thing, as some operations are much more difficult in some languages than others.

The API consists of a few different URL endpoints, accessible over HTTP/S. If configured, they can be secured using Integrated Windows Authentication or Basic Authentication using whatever granular feed- or system-level privileges needed.

In ProGet, all endpoints are prefixed with /upack/«feed-name»:

Package Endpoints:

• List Packages - describes specified packages
• Upload Package - uploads a specified package
• Delete Package - deletes a specified package
• Download Package - downloads a specified package
• Download Virtual Package - downloads a specified virtual package
• Import Package - imports a package from specified source

Other Endpoints:

• Download File - downloads a specified file within a package
• Feed Metadata - describes a specified feed
• List Versions - describes versions of specified packages

Unsupported Endpoints:

• Search Packages (Unsupported) - describes a list of packages

Note that the endpoint prefix itself is not a valid API endpoint, and may return a 404 error, or simply redirect you to this page.

Currently, the API only returns results in JSON format with a standard, 200 (success) status code unless there's an error; future versions (if anyone requests it) may add additional formats, such as XML, which would be specified using a Content-Type request headers and/or an alternate querystring parameter.

All searching and matching is case insensitive. This will most certainly never change, as it's either a mistake or a bad practice to have different packages named SomeThing and someThing.

Authenticating to Asset Directory API Endpoints

The following is a summary of access types and their corresponding requirements for various API keys types and endpoints within this API.

To specify an API Key, use the request header (X-ApiKey), querystring (key), or api:«api-key» as the username. See API Key Usage to learn more.

curl -X GET --header "X-ApiKey: abc12345" "https://proget.corp.local/upack/MyUniversalFeed/meta"

Data Specifications

FeedMetadata Object Attributes

FeedMetadata is a set of key/value pairs that correspond to the metadata fields in a Universal Feed. It's used as output data for the Feed Metadata
Endpoint as a JSON-formatted object.

JSON Object

{
  "apiVersion": "1.3.0",
  "name": "myUniversalFeed",
  "description": "A Universal Feed",
  "packageCount": 4,
  "packageVersionCount": 5,
  "services": [
    "VirtualPackages",
    "RemotePackages",
    "UploadPackage",
    "UploadContents",
    "Delete",
    "DownloadContents"
  ]
}

PackageData Object Attributes

PackageData is a set of key/value pairs that correspond to the metadata fields in a Universal Package. It's used as output data for the List Packages
Endpoint as a JSON-formatted object.

JSON Object

[
  {
    "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
]

VersionData Object Attributes

VersionData is a set of key/value pairs that correspond to the metadata fields in a Universal Package version. It's used as output data for the List Versions
Endpoint as a JSON-formatted object.

JSON Object

{
  "isLocal": true,
  "isCached": false,
  "isVirtual": false,
  "sha1": "00c1624a6bc2fbed3a8b49c9c90fa4f2b4a1241e",
  "title": "Test Package",
  "description": "Test Package for API Documentation",
  "group": "MyGroup",
  "name": "MyUniversalPackage",
  "version": "1.0.0",
  "downloads": 6,
  "published": "2023-12-11T02:13:47.86Z",
  "size": 1435884,
  "fileList": [ FileData objects ]
}

FileData Object Attributes

FileData is a subset of attributes on the VersionData Object that corresponds to fields of a file within a universal package. It's used as output data for the List Versions
Endpoint as a JSON-formatted object.

JSON Object

{
    "name": "example.bin",
    "size": 1543944,
    "date": "2023-12-08T10:25:50Z"
}