Internet Explorer is no longer supported. Many things will still work, but your experience will be degraded and some things won't function. Please use a modern browser such as Edge, Chrome, or Firefox.

Delete ApiKey

view on GitHub

Delete ApiKey is available as both a pgutil command and an HTTP Request, and will delete an API key in ProGet.

This API requires ProGet 2024.3 or later.

Command Specification (CLI)

The apikeys delete command requires an --id option and has an optional --source and related authentication options (i.e. --api-key or --username / --password). See Working with Sources in pgutil to learn more.

Example: Finding then Deleting an API Key

You can find the Id of an ApiKey using the apikeys list command. See List ApiKeys to learn more.

$> pgutil apikeys list
(unnamed key)
  Id:          1000
  Expiration:  None
  Logging:     None
  Type:        Personal
  User:        Admin
  
  
$> pgutil apikeys delete --id=1000
Deleting API key (id=1000)...
API key deleted.

HTTP Request Specification

To delete an API key, simply POST to /api/api-keys/delete?id=«apikey-id».

HTTP Response Specification

A successful 200 response indicates the API key has been deleted. A 403 response indicates a missing, unknown, or unauthorized API Key.