ProGet Documentation

Native API Reference

These methods are callable through JSON, SOAP, or SQL. Note that the Native API must be explicitly enabled by setting an API key under Administration > All Settings. Because this is a low-level API, specific user or task authorization is not performed and, if needed, may be done through the various Security_ methods.

Method Listing

This listing was generated from ProGet 4.3, and may be different in earlier releases. To see the api methods for your specific version, visit /reference/api in your Otter installation.

Input Output
BowerPackages_CreateOrUpdatePackage
Creates a new Bower package in the system, or updates an existing one.
Feed_Id (Int32)
Package_Name (String)
Repository_Url (String)
none
BowerPackages_DeletePackage
Deletes a Bower package.
Feed_Id (Int32)
Package_Name (String)
none
BowerPackages_GetPackage
Gets the specified package in a Bower feed.
Feed_Id (Int32)
Package_Name (String)
DataRow (BowerPackages)
BowerPackages_GetPackages
Gets the packages in a Bower feed.
Feed_Id (Int32) DataTable (BowerPackages)
Configuration_GetConfiguration
Gets the a complete list of ProGet configuration settings.
none DataTable (Configuration)
Configuration_GetValue
Gets the specified ProGet configuration value.
Key_Name (String) DataRow (Configuration)
Configuration_SetValue
Sets a ProGet configuration value.
Key_Name (String)
Value_Text (String)
none
Connectors_CreateOrUpdateConnector
Creates a new connector in the system, or updates an existing one.
FeedType_Name (String)
Connector_Name (String)
Connector_Url (String)
Filter_Csv (String)
User_Name (String)
Password_Bytes (Byte[])
Timeout_Period (Int32)
Connector_Id (Int32)
Connector_Id
Connectors_DeleteConnector
Deletes a connector.
Connector_Id (Int32) none
Connectors_GetConnector
Gets the specified connector.
Connector_Id (Int32) DataRow (Connectors)
Connectors_GetConnectors
Gets all of the connectors.
Feed_Id (Int32) DataTable (Connectors)
Dashboards_GetDashboardInfo
Gets data relevant to the ProGet homepage.
Packages_Count (Int32)
IncludeInactive_Indicator (YNIndicator)
DataSet (DashboardPackages_Latest, DashboardFeeds)
Dashboards_GetLargestPackages
Gets information about the largest packages in a feed.
Feed_Id (Int32) DataTable (DashboardPackages_Largest)
DockerBlobs_GetBlobs
Gets all of the blobs in a feed.
Feed_Id (Int32) DataTable (DockerBlobs)
DockerImages_GetImage
Gets the Docker image with the specified tag or digest.
Feed_Id (Int32)
Repository_Name (String)
TagOrDigest_Name (String)
DataRow (DockerImages)
DockerImages_GetImages
Gets the Docker images that match the specified criteria.
Feed_Id (Int32)
Repository_Name (String)
DataTable (DockerImages)
DockerImages_GetRepositories
Gets the Docker repositories that match the specified criteria.
Feed_Id (Int32)
SearchTerm_Text (String)
DataTable (DockerRepositories)
DockerImages_GetTags
Gets the Docker image tags for the specified repository.
Feed_Id (Int32)
Repository_Name (String)
DataTable (DockerImageTags)
DockerImages_UpdateDescription
Updates the short or full description of a Docker repository.
Feed_Id (Int32)
Repository_Name (String)
ShortDescription_Text (String)
FullDescription_Text (String)
none
EventOccurrences_GetOccurrence
Gets details about a specific event occurrence.
EventOccurrence_Id (Int32) DataRow (EventOccurrences)
EventOccurrences_GetOccurrences
Gets all event occurrences, optionally filtered by feed.
Feed_Id (Int32) DataTable (EventOccurrences)
EventOccurrences_GetUsers
Gets all of the users which have initiated events.
none DataTable (EventOccurrences_Users)
EventTypes_GetEventTypes
Gets all of the event types.
none DataTable (EventTypes)
Executions_DeleteExecution
Permanently deletes all data for the specified execution.
Execution_Id (Int32) none
Executions_GetExecution
Gets information about an execution as well as all of the log entries for it.
Execution_Id (Int32) DataSet (Executions, ExecutionLogEntries)
Executions_GetFeedSyncExecutions
Gets some or all of the replication executions for a feed.
Feed_Id (Int32)
Max_Results (Int32)
DataTable (Executions)
FeedAdapters_CreateOrUpdateFeedAdapter
Creates a new feed adapter or updates an existing one.
Feed_Id (Int32)
FeedAdapter_Sequence (Int32)
FeedAdapter_Name (String)
FeedAdapterType_Code (String)
FeedAdapter_Configuration (String)
none
FeedAdapters_DeleteFeedAdapter
Deletes a feed adapter.
Feed_Id (Int32)
FeedAdapter_Sequence (Int32)
none
FeedAdapters_GetFeedAdapters
Gets all of adapters associated with the specified feed
Feed_Id (Int32) DataTable (FeedAdapters)
FeedPackageFilters_CreateOrUpdatePackageFilter
Creates a new feed package filter or updates an existing one.
Feed_Id (Int32)
PackageFilter_Name (String)
PackageFilter_Configuration (String)
Sequence_Number (Int32)
Sequence_Number
FeedPackageFilters_DeletePackageFilter
Deletes a feed package filter.
Feed_Id (Int32)
Sequence_Number (Int32)
none
FeedPackageFilters_GetPackageFilters
Returns all of the package filters for a feed.
Feed_Id (Int32) DataTable (FeedPackageFilters)
FeedRetentionRules_CreateOrUpdateRule
Creates a new feed retention rule or updates an existing one.
Feed_Id (Int32)
DeletePrereleaseVersions_Indicator (YNIndicator)
DeleteCached_Indicator (YNIndicator)
KeepVersions_Count (Int32)
KeepUsedWithin_Days (Int32)
DeletePackageIds_Csv (String)
KeepPackageIds_Csv (String)
SizeTrigger_KBytes (Int64)
SizeExclusive_Indicator (YNIndicator)
Sequence_Number (Int32)
Sequence_Number
FeedRetentionRules_DeleteRule
Deletes a feed retention rule.
Feed_Id (Int32)
Sequence_Number (Int32)
none
FeedRetentionRules_GetRules
Gets the retention rules for a feed.
Feed_Id (Int32) DataTable (FeedRetentionRules_Extended)
FeedRetentionRules_ResequenceRule
Resequences a feed retention rule.
Feed_Id (Int32)
Sequence_Number (Int32)
New_Sequence_Number (Int32)
none
Feeds_AddFeedConnector
Associates a connector with a feed.
Feed_Id (Int32)
Connector_Id (Int32)
none
Feeds_CreateOrUpdateBowerFeed
Creates a new Bower feed or updates an existing one.
Feed_Id (Int32)
Feed_Name (String)
Feed_Description (String)
Active_Indicator (YNIndicator)
Cache_Connectors_Indicator (YNIndicator)
Feed_Id
Feeds_CreateOrUpdateDockerFeed
Creates a new Docker feed or updates an existing one.
Feed_Id (Int32)
Feed_Name (String)
Feed_Description (String)
Active_Indicator (YNIndicator)
Feed_Id
Feeds_CreateOrUpdateMavenFeed
Creates a new Maven feed or updates an existing one.
Feed_Id (Int32)
Feed_Name (String)
Feed_Description (String)
Active_Indicator (YNIndicator)
Cache_Connectors_Indicator (YNIndicator)
Feed_Id
Feeds_CreateOrUpdateNpmFeed
Creates a new npm feed or updates an existing one.
Feed_Id (Int32)
Feed_Name (String)
Feed_Description (String)
Active_Indicator (YNIndicator)
Cache_Connectors_Indicator (YNIndicator)
DropPath_Text (String)
Feed_Id
Feeds_CreateOrUpdateNuGetFeed
Creates a new NuGet feed or updates an existing one.
Feed_Id (Int32)
Feed_Name (String)
Feed_Description (String)
Active_Indicator (YNIndicator)
Cache_Connectors_Indicator (YNIndicator)
FeedPathOverride_Text (String)
APIKey_Text (String)
SymbolServerEnabled_Indicator (YNIndicator)
PackageStoreConfiguration_Xml (String)
FeedType_Name (String)
StripSymbolFiles_Indicator (YNIndicator)
DropPath_Text (String)
Feed_Id
Feeds_CreateOrUpdateProGetFeed
Creates a new Universal feed or updates an existing one.
Feed_Id (Int32)
Feed_Name (String)
Feed_Description (String)
Active_Indicator (YNIndicator)
Cache_Connectors_Indicator (YNIndicator)
DropPath_Text (String)
Feed_Id
Feeds_DeleteFeed
Deletes the specified feed.
Feed_Id (Int32) none
Feeds_DeleteFeedConnector
Dissociates a connector with a feed.
Feed_Id (Int32)
Connector_Id (Int32)
none
Feeds_DeleteSyncSettings
Deletes any sync settings for a feed.
Feed_Id (Int32) none
Feeds_GetFeed
Gets the details of a feed by either name or ID.
Feed_Id (Int32)
Feed_Name (String)
DataRow (Feeds)
Feeds_GetFeedConnectors
Gets the connectors for a feed.
Feed_Id (Int32)
Feed_Name (String)
DataTable (FeedConnectors_Extended)
Feeds_GetFeeds
Gets all of the feeds.
IncludeInactive_Indicator (YNIndicator) DataTable (Feeds)
Feeds_GetLicenseUrls
Gets the license urls for a feed
Feed_Id (Int32) DataTable (FeedLicenseUrls)
Feeds_GetMavenFeed
Gets the details of a Maven feed using either an ID or a name.
Feed_Id (Int32)
Feed_Name (String)
DataSet (Feeds, FeedConnectors_Extended)
Feeds_GetNpmFeed
Gets the details of an npm feed using either an ID or a name.
Feed_Id (Int32)
Feed_Name (String)
DataSet (Feeds, FeedConnectors_Extended)
Feeds_GetNuGetFeed
Gets the details of a NuGet feed using either an ID or a name.
Feed_Id (Int32)
Feed_Name (String)
DataSet (NuGetFeeds_Extended, FeedConnectors_Extended, FeedLicenseUrls)
Feeds_GetSyncFeeds
Gets all of the sync feeds.
none DataSet (NuGetSyncFeeds, NuGetFeeds_Extended)
Feeds_GetSyncSettings
Gets the settings for a sync feed.
Feed_Id (Int32) DataRow (NuGetSyncFeeds)
Feeds_SetFeedProperty
Sets one or more properties on a feed of any type.
Feed_Id (Int32)
Feed_Name (String)
Feed_Description (String)
Active_Indicator (YNIndicator)
Cache_Connectors_Indicator (YNIndicator)
FeedType_Name (String)
DropPath_Text (String)
FeedPathOverride_Text (String)
PackageStoreConfiguration_Xml (String)
SyncToken_Bytes (Byte[])
SyncTarget_Url (String)
none
Feeds_SetLicenseUrls
Sets the license urls for a particlar feed.
Feed_Id (Int32)
LicenseUrls_Xml (String)
none
Feeds_SetNuGetFeedProperty
Sets one or more properties on a feed of any type.
Feed_Id (Int32)
APIKey_Text (String)
SymbolServerEnabled_Indicator (YNIndicator)
StripSymbolFiles_Indicator (YNIndicator)
Legacy_Indicator (YNIndicator)
none
Feeds_UpdateSyncSettings
Updates sync settings for a feed.
Feed_Id (Int32)
Sync_Url (String)
RemoteFeed_Name (String)
RemoteFeed_APIKey_Bytes (Byte[])
Sync_Frequency_Minutes (Int32)
Active_Indicator (YNIndicator)
none
IndexingServers_DeleteServer
Deletes an indexing server.
Server_Name (String) none
IndexingServers_GetServers
Gets the indexing servers registered with ProGet.
none DataTable (IndexingServers)
LogMessages_DeleteMessages
Deletes one or all messages from the error log.
LogMessage_Id (Int32)
Category_Name (String)
none
LogMessages_GetMessage
Gets a specified message from the error log.
LogMessage_Id (Int32) DataRow (LogMessages)
LogMessages_GetMessages
Gets the messages from the error log that match the specified criteria.
Row_Count (Int32)
IncludeReadMessages_Indicator (YNIndicator)
Category_Name (String)
Message_Level (Int32)
DataTable (LogMessages)
MavenArtifacts_GetArtifactFiles
Gets the files associated with a Maven artifact.
Feed_Id (Int32)
GroupId_Text (String)
ArtifactId_Text (String)
Version_Text (String)
File_Type (String)
DataTable (MavenArtifactFiles_Extended)
MavenArtifacts_GetArtifacts
Gets the Maven artifacts in a feed.
Feed_Id (Int32)
GroupId_Text (String)
ArtifactId_Text (String)
DataTable (MavenArtifacts_Extended)
MavenArtifacts_GetArtifactVersions
Gets all of the versions of a Maven artifact.
Feed_Id (Int32)
GroupId_Text (String)
ArtifactId_Text (String)
DataTable (MavenArtifacts_Versions)
NpmConnectors_GetPackages
Gets the npm connector packages which match the specified criteria.
Connector_Id (Int32)
IncludeName_Csv (String)
ExcludeName_Csv (String)
ModifiedAfter_Date (DateTime)
MaxResults_Count (Int32)
DataTable (NpmConnectorPackages)
NpmFeeds_GetAllPackageVersions
Gets all versions of all of the packages in an npm feed.
Feed_Id (Int32) DataTable (NpmPackages_AllVersions)
NpmFeeds_GetConnectorPackage
Gets a package from a feed's connector with the specified name and version.
Feed_Id (Int32)
Package_Name (String)
Package_Version (String)
DataRow (NpmConnectorPackages)
NpmFeeds_GetLatestPackageVersions
Gets the latest versions of packages in a feed.
Feed_Id (Int32)
Since_Date (DateTime)
DataTable (NpmPackages_Latest)
NpmFeeds_SetTagVersion
Sets the version which a package tag points to.
Feed_Id (Int32)
Package_Name (String)
Scope_Name (String)
Tag_Name (String)
Tag_Version (String)
none
NpmPackages_CreateOrUpdatePackage
Creates a new npm package or updates an existing one.
Feed_Id (Int32)
Package_Name (String)
Scope_Name (String)
Version_Text (String)
PackageJson_Bytes (Byte[])
Published_Date (DateTime)
Tag_Name (String)
PackageHash_Bytes (Byte[])
Cached_Indicator (YNIndicator)
Package_Size (Int64)
none
NpmPackages_DeletePackage
Deletes a package in an npm feed.
Feed_Id (Int32)
Package_Name (String)
Scope_Name (String)
Version_Text (String)
none
NpmPackages_GetPackage
Gets a package and its versions and tags.
Feed_Id (Int32)
Package_Name (String)
Scope_Name (String)
DataSet (NpmPackages, NpmPackageVersions, NpmPackageTags)
NuGetPackages_CreateOrUpdatePackage
Creates a new package or updates an existing one.
Feed_Id (Int32)
Package_Id (String)
Version_Text (String)
TargetFrameworks_Text (String)
Published_Date (DateTime)
Package_Size (Int64)
PackageHash_Bytes (Byte[])
NuspecFile_Bytes (Byte[])
Symbols_Indicator (YNIndicator)
Source_Indicator (YNIndicator)
Cached_Indicator (YNIndicator)
SymbolFiles_Xml (String)
Listed_Indicator (YNIndicator)
Download_Count (Int32)
PackageHashRequired_Indicator (YNIndicator)
PackageHashRequired_Indicator
NuGetPackages_GetLatest
Gets all of the latest packages in a feed.
Feed_Id (Int32)
PackageIds_Psv (String)
DataTable (NuGetPackages_Latest)
NuGetPackages_GetLatestStable
Gets all of the latest stable packages in a feed.
Feed_Id (Int32)
PackageIds_Psv (String)
DataTable (NuGetPackages_LatestStable)
NuGetPackages_GetPackage
Gets information about a package in a feed.
Feed_Id (Int32)
Package_Id (String)
Version_Text (String)
DataSet (NuGetPackages_Extended, NuGetPackageSymbols)
NuGetPackages_GetPackageCount
Gets the number of packages in the system that meet the specified criteria.
Feed_Id (Int32)
Package_Id (String)
Package_Count (Int32)
Package_Count
NuGetPackages_GetPackages
Gets all of the packages in a feed.
Feed_Id (Int32)
PackageIds_Psv (String)
DataTable (NuGetPackages_Extended)
NuGetPackages_SetListed
Lists or unlists a NuGet package.
Feed_Id (Int32)
Package_Id (String)
Version_Text (String)
Listed_Indicator (YNIndicator)
none
NuGetPackageSymbols_GetSymbols
Gets the best symbol matches.
Feed_Id (Int32)
Symbol_Id (Byte[])
SymbolFileName_Text (String)
Symbol_Age (Int32)
DataTable (NuGetPackageSymbols)
Packages_GetPackages
Gets a list of combined packages filtering by the specified criteria.
Packages_Count (Int32)
Feed_Id (Int32)
PublishedBefore_Date (DateTime)
DataTable (Packages_Combined)
ProGetPackages_CreateOrUpdatePackage
Creates a new ProGet package or updates an existing one.
Feed_Id (Int32)
Group_Name (String)
Package_Name (String)
Version_Text (String)
PackageMetadata_Bytes (Byte[])
Published_Date (DateTime)
PackageHash_Bytes (Byte[])
Cached_Indicator (YNIndicator)
Package_Size (Int64)
Title_Text (String)
Description_Text (String)
IconUrl_Text (String)
LatestVersion_Text (String)
none
ProGetPackages_GetPackageCount
Gets the number of packages in a ProGet feed.
Feed_Id (Int32)
IncludeVersions_Indicator (YNIndicator)
Package_Count (Int32)
Package_Count
ProGetPackages_GetPackages
Gets the packages in a ProGet feed.
Feed_Id (Int32)
Group_Name (String)
Package_Name (String)
DataTable (ProGetPackages)
ProGetPackages_GetPackageVersions
Gets the package versions in a ProGet feed.
Feed_Id (Int32)
Group_Name (String)
Package_Name (String)
Version_Text (String)
DataTable (ProGetPackageVersions_Extended)
ProGetPackages_GetPopularPackages
Gets the packages in a ProGet feed that have been downloaded the most.
Feed_Id (Int32)
Max_Count (Int32)
DataTable (ProGetPackages)
ProGetPackages_SearchPackages
Searhes the packages in a ProGet feed.
Feed_Id (Int32)
Search_Term (String)
DataTable (ProGetPackages)
ScheduledTasks_GetExecutions
Gets some or all of the executions of a scheduled task.
ScheduledTask_Id (Int32)
Max_Results (Int32)
DataTable (Executions)
ScheduledTasks_GetScheduledTasks
Gets all of the scheduled tasks, optionally filtered by feed.
Feed_Id (Int32) DataTable (ScheduledTasks_Extended)
ScheduledTasks_UpdateScheduledTask
Updates the configuration of a scheduled task.
ScheduledTask_Id (Int32)
Frequency_Hours (Int32)
StartTimeOfDay_Minutes (Int32)
EndTimeOfDay_Minutes (Int32)
Active_Indicator (YNIndicator)
RunImmediately_Indicator (YNIndicator)
none
Security_AddPrivilege
Grants or denies the specified principal the ability to perform a certain role.
Privilege_Id (Int32)
UserDirectory_Id (Int32)
Principal_Name (String)
PrincipalType_Code (String)
Role_Id (Int32)
Feed_Id (Int32)
PrivilegeType_Code (String)
Privilege_Id
Security_CreateOrUpdateRole
Creates or updates a role.
Role_Id (Int32)
Role_Name (String)
Role_Description (String)
Tasks_Csv (String)
Role_Id
Security_DeleteRole
Deletes the specified role.
Role_Id (Int32) none
Security_GetPrivileges
Gets a list of privileges assigned in the system.
UserDirectory_Id (Int32)
PrincipalType_Code (String)
DataTable (Privileges_Extended)
Security_GetRole
Gets the specified role in the database, along with all the tasks that comprise the role
Role_Id (Int32) DataSet (Roles, RoleTasks_Extended)
Security_GetRoles
Gets all the roles in the system, along with all the tasks comprising each role
none DataSet (Roles, RoleTasks_Extended)
Security_GetTasks
Gets all of the tasks in the system.
none DataTable (Tasks)
Security_GetUserPrivileges
Gets the list of privileges specifically assigned to a user or any specified groups.
UserDirectory_Id (Int32)
User_Name (String)
GroupNames_Csv (String)
DataTable (Privileges_Extended)
Security_RemovePrivilege
Deletes a privilege.
Privilege_Id (Int32) none
Users_CreateGroup
Creates a new user group.
Group_Name (String) none
Users_CreateOrUpdateUser
Creates or modifies a user.
User_Name (String)
Display_Name (String)
Email_Address (String)
Groups_Xml (String)
none
Users_DeleteGroup
Deletes a user group from the system, but does not delete the users who belong to the group.
Group_Name (String) none
Users_DeleteUser
Deletes a user.
User_Name (String) none
Users_GetGroups
Gets a list of user groups in the system
none DataTable (Groups)
Users_GetUser
Gets the details of the specified user, and a list of all the groups the user belongs to
User_Name (String) DataSet (Users, UserGroups)
Users_GetUsers
Gets all the users in the system, along with all the groups in the system
none DataSet (Users, UserGroups)
Users_GetUsersInGroup
Gets a list of users in the specified group
Group_Name (String) DataTable (Users)