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.
 
No matching results found

Universal Feed API

view on GitHub

Universal Feeds can be queried using the Common Packages API. There is also a special Universal Feed API, which was developed before the Common Packages API. While the Universal Feed API is still functional, we recommend using the Common Packages API if a required endpoint is available.

Universal Feed Endpoints

These endpoints are part of the original Universal Feed API and offer additional functionality. 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. All endpoints are prefixed with /upack/«feed-name»:

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.

Deprecated Universal Feed Endpoints:

These endpoints are deprecated, and we recommend using the appropriate endpoints in the Common Packages API instead.

The Data Objects for the List Universal Packages and List Universal Package Versions endpoints can also be found on the deprecated documentation

Authenticating to API Endpoints

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

Access Type Requirements
System API Keys Use/Manage Feeds
Feed API Keys View/Download is required for all endpoints
Add/Repackage is required for uploading/importing endpoints
Overwrite/Delete is required for deletion endpoints
Personal API Key Feeds_ViewFeed is required for all endpoints
Feeds_AddPackage is required for uploading/importing endpoints
Feeds_DeletePackage is required for deletion endpoints
No API Key anonymous or authenticated user must have at least Feeds_ViewFeed

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.

🚀 Quick Example: Authenticating with curl

For example, to authenticate with the API key abc12345 to the "Import Universal Package" endpoint, you could specify the API key as follows:

curl -X GET --header "X-ApiKey: abc12345" "https://proget.corp.local/upack/MyUniversalFeed/import"
In this article

inedo.com | Support | MyInedo

docs © 2024 Inedo, LLC