List Connectors

List Connectors is available as both a pgutil command and an HTTP Request, and will return an array of ProGetConnector objects, describing all existing connectors.

pgutil connectors list

Command Specification (CLI)

The connectors list command is used to list all existing connectors.

Listing all connectors does not require any additional options:

pgutil connectors list

This will return a list of connectors, their type, and their URL:

myNugetConnector (nuget) https://proget.connector.local
nuget.org (nuget) https://api.nuget.org/v3/index.json
pypi.org (pypi) https://pypi.org/
registry.npmjs.org (npm) https://registry.npmjs.org
rubygems.org (rubygems) https://api.rubygems.org/

HTTP Request Specification

To list all existing connectors, simply GET to the URL with an appropriate API Key.

GET /api/management/connectors/list

HTTP Response Specification

A successful (200) response body will contain an array of ProgetConnector objects. For example:

GET /api/management/connectors/list

[
  {
      "name": "nuget.org",
      "url": "https://api.nuget.org/v3/index.json",
      "feedType": "nuget",
      "username": "jsmith",
      "password": "pass123",
      "timeout": 60,
      "filters": ["filter1", "filter2"],
      "metadataCacheEnabled": true,
      "metadataCacheMinutes": 30,
      "metadataCacheCount": 100
  },
  {
      "name": "registry.npmjs.org",
      "url": "https://registry.npmjs.org",
      "feedType": "npm",
      "timeout": 10,
      "metadataCacheEnabled": false,
      "metadataCacheMinutes": null,
      "metadataCacheCount": null,
      "filters": []
  },
  { ... } // other connectors
]

Sample Usage Scripts

List all connectors (Powershell)

This script will print a list of all existing connectors, their feed types and URLs.

$apiUrl = "https://proget.corp.local/api/management/connectors/list"
$apiKey = "abc12345"

$headers = @{"X-ApiKey" = $apiKey}

$response = Invoke-RestMethod -Uri $apiUrl -Method Get -Headers $headers

foreach ($connector in $response) {
    $connectorName = $connector.name
    $connectorType = $connector.feedType
    $connectorUrl = $connector.url
    $formattedConnector = "{0} ({1}) {2}" -f $connectorName, $connectorType, $connector.url
    Write-Host $formattedConnector
}

Example Output:

nuget.org (nuget) https://api.nuget.org/v3/index.json
registry.npmjs.org (npm) https://registry.npmjs.org
...
...