Feed Management API

The Feed Management API Endpoints offer a simple mechanism for querying, creating, and updating feeds, and related data:

• Create Feed - creates a specified feed
• Get Feed - describes an specified feed
• List Feeds - describes all feeds, filtered as specified
• Update Feed - updates a specified feed
• Delete Feed - deletes a specified feed

Authenticating to Feed Management 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/api/management/feeds/list"

Data Specifications

Feed Object Attributes

Feed is a set of key/value pairs that correspond to the fields on a Feed. It's used as input for the Create Feed endpoint, and output for the Get Feed and List Feed endpoints.

name and feedType properties are required for the Create Feed Endpoint. Unless otherwise indicated, omitting a property or supplying null as the value will keep the current setting.

JSON Object

{
  "name": "myNugetFeed",
  "feedType": "nuget",
  "description": "Example NuGet Feed",
  "active": true,
  "cacheConnectors": true,
  "dropPath": "/path/to/drop",
  "packagesPath": "/path/to/packages",
  "packageStore": null,
  "allowUnknownLicenses": true,
  "allowedLicenses": ["MIT", "GPL-3.0"],
  "blockedLicenses": [],
  "connectors": ["connector1", "connector2"],
  "vulnerabilitySources": ["source1", "source2"],
  "retentionRules": [
    {
      "deletePrereleaseVersions": false,
      "deleteCached": true,
      "keepVersionsCount": 5,
      "keepUsedWithinDays": 30,
      "triggerDownloadCount": 100,
      "keepPackageIds": ["package1", "package2"],
      "deletePackageIds": [],
      "keepVersions": ["1.0.0", "2.0.0"],
      "deleteVersions": []
    }
  ],
  "packageFilters": ["filter1", "filter2"],
  "packageAccessRules": ["rule1", "rule2"],
  "replication": 
        {
        "clientMode": "pushonly",
        "serverMode": "readonly",
        "clientToken": "client-token",
        "serverToken": "server-token",
        "sourceUrl": "http://proget.corp.locall"
        },
  "variables": 
        {
        "variable1": "value1",
        "variable2": "value2"
        },
  "packageStatisticsEnabled": true,
  "restrictPackageStatistics": true,
  "deploymentRecordsEnabled": true,
  "usageRecordsEnabled": true,
  "vulnerabilitiesEnabled": true,
  "licensesEnabled": true,
  "useWithProjects": true,
  "retentionRulesEnabled": true
}

NuGet Only

JSON Object

{
  "symbolServerEnabled": true,
  "stripSymbols": false,
  "stripSource": true,
  "stripSignature": false,
  "useApiV3": true
}

RetentionRule Object Attributes

RetentionRule is a subset of attributes on the Feed Object.

JSON Object

{
  "deletePrereleaseVersions": false,
  "deleteCached": true,
  "keepVersionsCount": 5,
  "keepUsedWithinDays": 30,
  "triggerDownloadCount": 100,
  "keepPackageIds": ["package1", "package2"],
  "deletePackageIds": [],
  "keepVersions": ["1.0.0", "2.0.0"],
  "deleteVersions": [],
  "sizeTriggerKb": 1024,
  "sizeExclusive": true
}

Replication Object Attributes

Replication is a subset of attributes on the Feed Object.

JSON Object

{
  "clientMode": "pushonly",
  "serverMode": "readonly",
  "clientToken": "client-token",
  "serverToken": "server-token",
  "sourceUrl": "http://replication-server-url"
}

Notes about Data

Wildcards and Negations

Certain fields noted above support wildcard and negation syntax. For example, the value ["Microsoft.*", "Castle.*", "!Rubbishsoft.*"] has the following properties:

• includes any packages that start with Microsoft. or Castle.*
• excludes any packages that start with Rubbishsoft.

Feed & Package Types

In ProGet UI, Chocolatey and PowerShell are represented as separate feed types, even though they only contain NuGet packages and use the same NuGet API. For this reason, in ProGet UI, you can switch the type of a feed' between NuGet, Chocolatey, and PowerShell at any time, but not between other feed types.

The API allows feed types to be changed only within the following feed type groups (anything else generates a 400 error):

• universal and romp
• nuget, chocolatey, and powershell

Persisted XML Configuration

Because package stores, package filters, and package access rules are implemented by extensible runtime components (i.e., you can create your own using the Inedo SDK), ProGet stores configuration for these components in "Persisted XML", which is a lightweight object serialization format that Inedo products use.

The easiest way to see what an object's persisted XML will look like is to create it in the UI, then look at the XML in either the database or the API List Feeds or Get Feed request. As a reference, we've provided the persisted XML for both supported package stores and a general example:

AWS

<Inedo.ProGet.Extensions.AWS.PackageStores.S3FileSystem Assembly="AWS">
  <Properties AccessKey="{publicAccessKey}" SecretAccessKey="{privateAccessKey}" BucketName="{bucketName}" TargetPath="{pathInsideBucketDefaultIsRoot}" ReducedRedundancy="{False}" MakePublic="{False}" Encrypted="False" RegionEndpoint="{us-east-1}" CustomServiceUrl="{customServiceUrl}" />
</Inedo.ProGet.Extensions.AWS.PackageStores.S3FileSystem>

Azure Blob Storage

<Inedo.ProGet.Extensions.Azure.PackageStores.AzureFileSystem Assembly="Azure">
  <Properties ConnectionString="{DefaultEndpointsProtocol=https;AccountName=account-name;AccountKey=account-key}" ContainerName="{blobContainerName}" TargetPath="{pathToFilesDefaultIsRoot}" />
</Inedo.ProGet.Extensions.Azure.PackageStores.AzureFileSystem>

Custom Extension Format

<{FullNamespace.ClassName} Assembly="AssemblyName">
  <Properties PropertyNameA="{property value}" PropertyNameB="1000" />
</{FullNamespace.ClassName}>

Default Feed Disk Path

If you don't specify a disk path for a feed to use, ProGet uses a path 'based on the 'system-generated ID. This means that, just as in UI, if you delete a feed and then recreate it with the same name, the disk path will be different.