ProGet Documentation

Native API Reference

  • Last Modified: 2019-11-27

The other endpoints should be used instead of the Native API Methods when possible, as they are much easier to use and will likely not change from version-to-version.

API Usage

All of these methods require that an API Key with Native API Access is passed into each request; see Using API Keys for more information.

Method Listing

The Native API Methods are automatically documented by a special page in the software. To see the API Methods for your specific version, go to Administration > Reference > API Methods, or directly visit http://your-proget-installation/reference/api in your installation.

Using the Native API

There are three interfaces for the native API: JSON, SOAP, and SQL. The native API interfaces take the same parameters and return the same data, so you should use the most convenient one for your programming environment.

JSON-based Access

The JSON interface for the native API can be used by any program that can perform HTTP requests and decode JSON. For example, here is a way to create a feed:

URL:
http://feeds.fd.local:2000/api/json/Feeds_CreateFeed

Header:
Content-Type: application/json

Body:
{
"Feed_Name" : "MyNewNuGetFeed",
"FeedType_Name" : "nuget",
"API_Key" : "«api-key»"
}

You can also use querystrings with the JSON-based API. To delete a package license and all associated rules, we need to perform two requests:

GET or POST /api/json/Licenses_GetLicenses?key=«api-key»

The first request gives us a JSON array containing JSON objects with properties of licenses in ProGet. Each license is uniquely identified with a License_Id, which we will feed into the next request:

POST /api/json/Licenses_DeleteLicense?key=«api-key»&License_Id=«application-id»

The response contains no data, as it's just a delete, and the built-in reference documentation indicates no return.

SOAP-based Access

The SOAP interface for the native API is useful for .NET programmers. Visual Studio can automatically generate code to connect to a SOAP API. To do this, add a Service Reference to your project with the URL http://your-proget-installation/api/soap.

Example from BuildMaster

The following example is for BuildMaster, but the concepts are identical in ProGet.

Adding a Service Reference

Here is an example of code that interacts with the SOAP API:

using System;
using System.Data;
using System.Linq;

namespace SoapApiExample
{
static class Program
{
    const string APIKey = "«api-key»";
    const string ApplicationName = "«application-name»";

    static void Main(string[] args)
    {
        using (var client = new buildmaster.ApiServiceSoapClient("ApiServiceSoap"))
        {
            var applicationId = (from app in client.Applications_GetApplications(APIKey, null, null).AsEnumerable()
                                 where string.Equals(app.Field<string>("Application_Name"), ApplicationName, StringComparison.OrdinalIgnoreCase)
                                 select app.Field<int>("Application_Id")).First();

            var releases = from script in client.DatabaseChangeScripts_GetChangeScripts(APIKey, applicationId, null, null, null).AsEnumerable()
                           let s = new
                           {
                               Release_Number = script.Field<string>("Release_Number"),
                               Script_Name = script.Field<string>("Script_Name")
                           }
                           group s by s.Release_Number;

            foreach (var scripts in releases)
            {
                Console.WriteLine($"Release {scripts.Key}");
                foreach (var s in scripts)
                {
                    Console.WriteLine(s.Script_Name);
                }
                Console.WriteLine();
            }
        }
    }
}
}

SQL-based Access

The SQL interface for the native API is useful for one-off applications because the code can run directly in the database, saving you the trouble of writing a full program.

The SQL interface also has access to some procedures not available in the JSON or SOAP interfaces. These internal procedures are not supported, but you may find them useful when writing a script. Additionally, because it operates directly on the database, the SQL interface is not restricted to procedures. In some cases, it may be easier to write one large query instead of many smaller ones.

Despite the increased power (and therefore danger) of the SQL interface, it can be used in the same way as the JSON or SOAP interfaces:

DECLARE @Application_Id INT

SELECT @License_Id = [License_Id] FROM [Licenses] WHERE [External_Id] = '«MIT, etc.»'

EXEC [Licenses_DeleteLicense] @License_Id = @License_Id

Is this documentation incorrect or incomplete? Help us by contributing!

This documentation is licensed under CC-BY-SA-4.0 and stored in GitHub.

Generated from commit 46f55761 on master