Get Connector

Get Connector is available as both a pgutil command and an HTTP Request, and will return a single ProgetConnector object or a list of properties for the specified connector.

pgutil connectors properties list --connector=myNugetConnector

Command Specification (CLI)

The connectors properties list command is used return the properties of a single connector.

The --connector option is always required.

Getting a connector requires the connector name (e.g. MyNugetConnector):

pgutil connectors properties list --connector=myNugetConnector

This will return the properties of the specified connector:

url=https://api.nuget.org/v3/index.json
feedType=nuget
timeout=10
metadataCacheEnabled=false
metadataCacheCount=*not set*
metadataCacheMinutes=*not set*

HTTP Request Specification

To return a specified connector, simply GET to the URL with the name of the connector and an appropriate API Key.

GET /api/management/connectors/get/«connector-name»

HTTP Response Specification

A successful (200) response body will contain a single ProGetConnector object. For example, to requesting a nuget connector with the name myConnector, the request would return:

GET /api/management/connectors/get/nuget.org

{
  "name": "myNugetConnector",
  "url": "https://proget.connector.local",
  "feedType": "nuget",
  "username": "jsmith",
  "password": "pass123",
  "timeout": 60,
  "filters": ["filter1", "filter2"],
  "metadataCacheEnabled": true,
  "metadataCacheMinutes": 30,
  "metadataCacheCount": 100
}