Create ApiKey

Modified on July 26, 2024

Create ApiKey is available as both a pgutil command and an HTTP Request, and will create a system, personal, or feed API key in ProGet.

pgutil apikeys create personal --source=https://proget.corp.local/ --username=jrdobbs --password=hunter42

This API requires ProGet 2024.3 or later.

Command Specification (CLI)

The apikeys create command set is used to create an ApiKey in a ProGet instance.

There are three commands available (system, personal, and feed), and each command has options that correspond to fields in the web UI, including --description, --expiration, --logging, --name, and --key. See Creating API Keys in ProGet to learn more.

These commands also have optional --source and related authentication options (i.e. --api-key or --username / --password). See Working with Sources in pgutil to learn more.

The key will be written to stdout on success.

Example: Creating a System API key with restrictions can be done by limiting the APIs (e.g. Feeds and SCA) and setting an expiration (`2024/08/01``).

pgutil apikeys create system --apis="feeds,sca" --expiration="2024/08/01"

Example: Creating a Feed API key requires a feed name (MyNpmFeed):

pgutil apikeys create feed --name=MyNpmFeed

Example: Creating a Feed API key for a group requires a feed group name (MyFeedGroup):

pgutil apikeys create feed --group=MyFeedGroup

Example: Creating a Personal Key for another user requires the user's name (johnsmith):

pgutil apikeys create personal --user=johnsmith

Note source options must also be specified unless you have the "Default" source configured, and that a feed may be instead specified in the source. See Working with Sources to learn more.

HTTP Request Specification

To create an API key, simply POST a ApiKeyInfo JSON object (see ApiKeyInfo.cs) as the request body to /api/api-keys/create.

A successful response body will contain the text of the API key created.

HTTP Response Specification