Licenses

The Licenses API provides several pgutil commands (available as pgutil licenses) and HTTP endpoints for querying, creating, and updating licenses, and related data:

pgutil Commands

All HTTP endpoints of the Licenses API are available as pgutil commands.

To find the list of commands available in pgutil, simply run pgutil licenses. See Getting started with pgutil to learn more.

Available HTTP Endpoints

• Create License - creates a specified license
• Get License - describes an specified license
• List Licenses - describes all licenses, filtered as specified
• Update License - updates a specified license
• Delete License - deletes a specified license

Authenticating to Licenses Management API

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/licenses/list"

Data Specifications

LicenseInfo Object Attributes

LicenseInfo is a JSON object (see LicenseInfo.cs) that corresponds to the fields on a license. It's used as input for Create License, and output for Get License and List Licenses.

code and title properties are required for Create License. Unless otherwise indicated, omitting a property or supplying null as the value will keep the current setting.

Example JSON Object

{
  "code": "MIT",
  "title": "MIT License",
  "urls": [
    "https://spdx.org/licenses/MIT.html"
  ],
  "spdx": ["MIT"]
}