ProGet Health API

There are two API endpoints that you can use to quickly obtain information about the health and status of ProGet instances and ProGet connectors.

• Get Instance Health - describes the health status of a ProGet instance
• Get Connector Health - describes the health status of ProGet connectors in a ProGet instance

Instance Health

The Get Instance Health is an endpoint that will return a ProGetHealth object describing the health of a ProGet instance.

Using this endpoint does not require an API key and can be accessed by simply adding /health to your ProGet URL (e.g. https://proget.corp.local/health)

curl -H "Content-Type: application/json" -X GET https://proget.corp.local/health

Request Specification

To return the health status of a ProGet instance, simply GET to the URL.

GET /health

Response Specification

A successful (200) response body will return a ProGetHealth object. For example, to querying the health of a ProGet instance, the request would return this:

GET /health

{
  "applicationName": "ProGet",
  "databaseStatus": "OK",
  "databaseStatusDetails": null,
  "extensionsInstalled": {
    "ProGetCoreEx": "23.0.27",
    "Inedo.SDK": "2.3.0",
    "Amazon AWS": "2.0.3",
    "Azure": "2.0.1",
    "InedoCore": "2.3.2",
    "Sonatype": "2.0.1"
  },
  "licenseStatus": "OK",
  "licenseStatusDetail": null,
  "versionNumber": "2023.27 (Build 5)",
  "releaseNumber": "23.0.27",
  "serviceStatus": "OK",
  "serviceStatusDetail": null,
  "replicationStatus": {
    "serverStatus": null,
    "serverError": null,
    "clientStatus": null,
    "clientError": null,
    "incoming": [],
    "outgoing": []
  }
}

ProGetHealth Object Attributes

ProGetHealth is a set of key/value pairs that describe the health status of a ProGet instance. It's used as output data for the Get ProGet Health endpoint as a JSON-formatted object.

ReplicationStatus Object Attributes

ReplicationStatus is a subset of data on the ProGetHealth Object that describes the status of replication servers and clients. It's used as output data for the Get ProGet Health endpoint.

Note that all values are optional (indicated by string?), and may be set to null or omitted.

ProGet Connector Health

The Get Connector Health is an endpoint that will return either a ConnectorHealth object or an array of objects describing the health of either one or all connectors in a ProGet instance.

The System API Key View Connector Health is required for this endpoint

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 --header "X-ApiKey: abc12345" -H "Content-Type: application/json" -X GET https://proget.corp.local/api/connector-health/3

403 The specified API key does not have the proper permissions to perform this action.

Request Specification

To return the health status of a ProGet connector, simply GET to the URL with an appropriate API Key

GET /api/connector-health/«connector-id»

Getting the health of a single ProGet connector requires the id (e.g. 3):

GET /api/connector-health/3

Getting the health of all ProGet connectors requires omitting the id:

GET /api/connector-health/

Response Specification

A successful (200) response body will return either a ConnectorHealth object or an array of objects.

To querying the health of a single ProGet connector, the request would return this:

GET /api/connector-health/3

{
    "id": 3,
    "name": "nuget.org",
    "url": "https://www.nuget.org/api/v2",
    "state": "unhealthy",
    "errorMessage": "Connection timed out."
    "lastChecked": "2019-03-29T17:41:55.05+00:00"
}

To querying the health of all ProGet connectors, the request would return this:

GET /api/connector-health/
[
    {
        "id": 1,
        "name": "npmjs.org",
        "url": "https://registry.npmjs.org",
        "state": "healthy",
        "lastChecked": "2019-03-29T17:41:59.907+00:00"
    },
    {
        "id": 2,
        "name": "chocolatey.org",
        "url": "https://www.chocolatey.org/api/v2",
        "state": "healthy",
        "lastChecked": "2019-03-29T17:41:59.903+00:00"
    },
    {
        "id": 3,
        "name": "nuget.org",
        "url": "https://www.nuget.org/api/v2",
        "state": "unhealthy",
        "erroMessage": "Connection timed out."
        "lastChecked": "2019-03-29T17:41:55.05+00:00"
    },
    {....}
]

ConnectorHealth Object Attributes

ConnectorHealth is a set of key/value pairs that describe the health status of connectors in a ProGet instance. It's used as output data for the Get ProGet Connector Health endpoint as a JSON-formatted object.

Some values are optional (indicated by string?), and may be set to null or an empty string.