Categorygithub.com/sonatype-nexus-community/nexus-repo-api-client-go
repositorypackage
3.74.1+incompatible
Repository: https://github.com/sonatype-nexus-community/nexus-repo-api-client-go.git
Documentation: pkg.go.dev

# Packages

No description provided by the author

# README

Go API client for sonatyperepo

This documents the available APIs into Sonatype Nexus Repository Manager as of version 3.74.0-05.

Overview

This API client was generated by the OpenAPI Generator project. By using the OpenAPI-spec from a remote server, you can easily generate an API client.

  • API version: 3.74.0-05
  • Package version: 1.0.0
  • Generator version: 7.9.0
  • Build package: org.openapitools.codegen.languages.GoClientCodegen For more information, please visit https://github.com/sonatype-nexus-community

Installation

Install the following dependencies:

go get github.com/stretchr/testify/assert
go get golang.org/x/net/context

Put the package under your project folder and add the following in import:

import sonatyperepo "github.com/sonatype-nexus-community/nexus-repo-api-client-go"

To use a proxy, set the environment variable HTTP_PROXY:

os.Setenv("HTTP_PROXY", "http://proxy_name:proxy_port")

Configuration of Server URL

Default configuration comes with Servers field that contains server objects as defined in the OpenAPI specification.

Select Server Configuration

For using other server than the one defined on index 0 set context value sonatyperepo.ContextServerIndex of type int.

ctx := context.WithValue(context.Background(), sonatyperepo.ContextServerIndex, 1)

Templated Server URL

Templated server URL is formatted using default variables from configuration or from context value sonatyperepo.ContextServerVariables of type map[string]string.

ctx := context.WithValue(context.Background(), sonatyperepo.ContextServerVariables, map[string]string{
	"basePath": "v2",
})

Note, enum values are always validated and all unused variables are silently ignored.

URLs Configuration per Operation

Each operation can use different server URL defined using OperationServers map in the Configuration. An operation is uniquely identified by "{classname}Service.{nickname}" string. Similar rules for overriding default operation server index and variables applies by using sonatyperepo.ContextOperationServerIndices and sonatyperepo.ContextOperationServerVariables context maps.

ctx := context.WithValue(context.Background(), sonatyperepo.ContextOperationServerIndices, map[string]int{
	"{classname}Service.{nickname}": 2,
})
ctx = context.WithValue(context.Background(), sonatyperepo.ContextOperationServerVariables, map[string]map[string]string{
	"{classname}Service.{nickname}": {
		"port": "8443",
	},
})

Documentation for API Endpoints

All URIs are relative to http://localhost/service/rest

ClassMethodHTTP requestDescription
AssetsAPIDeleteAssetDelete /v1/assets/{id}Delete a single asset
AssetsAPIGetAssetByIdGet /v1/assets/{id}Get a single asset
AssetsAPIGetAssetsGet /v1/assetsList assets
AzureBlobStoreAPIVerifyConnection2Post /v1/azureblobstore/test-connectionVerify connection using supplied Azure Blob Store settings
BlobStoreAPIConvertBlobStoreToGroupPost /v1/blobstores/group/convert/{name}/{newNameForOriginal}Convert a blob store to a group blob store
BlobStoreAPICreateBlobStore1Post /v1/blobstores/azureCreate an Azure blob store
BlobStoreAPICreateBlobStore2Post /v1/blobstores/googleCreate a Google Cloud blob store
BlobStoreAPICreateFileBlobStorePost /v1/blobstores/fileCreate a file blob store
BlobStoreAPICreateGroupBlobStorePost /v1/blobstores/groupCreate a group blob store
BlobStoreAPICreateS3BlobStorePost /v1/blobstores/s3Create an S3 blob store
BlobStoreAPIDeleteBlobStoreDelete /v1/blobstores/{name}Delete a blob store by name
BlobStoreAPIGetBlobStore1Get /v1/blobstores/azure/{name}Get an Azure blob store configuration by name
BlobStoreAPIGetBlobStore2Get /v1/blobstores/google/{name}Get the configuration for a Google Cloud blob store
BlobStoreAPIGetFileBlobStoreConfigurationGet /v1/blobstores/file/{name}Get a file blob store configuration by name
BlobStoreAPIGetGroupBlobStoreConfigurationGet /v1/blobstores/group/{name}Get a group blob store configuration by name
BlobStoreAPIGetRegionsByProjectIdGet /v1/blobstores/google/regions/{projectId}Get the project regions by project's id
BlobStoreAPIGetS3BlobStoreGet /v1/blobstores/s3/{name}Get a S3 blob store configuration by name
BlobStoreAPIListBlobStoresGet /v1/blobstoresList the blob stores
BlobStoreAPIQuotaStatusGet /v1/blobstores/{name}/quota-statusGet quota status for a given blob store
BlobStoreAPIUpdateBlobStore1Put /v1/blobstores/azure/{name}Update an Azure blob store configuration by name
BlobStoreAPIUpdateBlobStore2Put /v1/blobstores/google/{name}Update a Google Cloud blob store
BlobStoreAPIUpdateFileBlobStorePut /v1/blobstores/file/{name}Update a file blob store configuration by name
BlobStoreAPIUpdateGroupBlobStorePut /v1/blobstores/group/{name}Update a group blob store configuration by name
BlobStoreAPIUpdateS3BlobStorePut /v1/blobstores/s3/{name}Update an S3 blob store configuration by name
CleanupPoliciesAPICreate2Post /v1/cleanup-policiesCreate a new policy
CleanupPoliciesAPIDeletePolicyByNameDelete /v1/cleanup-policies/{name}Delete cleanup policy
CleanupPoliciesAPIGetAllGet /v1/cleanup-policiesGet a list of existing policies
CleanupPoliciesAPIGetCleanupPolicyByNameGet /v1/cleanup-policies/{name}Get a policy by name
CleanupPoliciesAPIUpdate2Put /v1/cleanup-policies/{policyName}Update existing policy
ComponentsAPIDeleteComponentDelete /v1/components/{id}Delete a single component
ComponentsAPIGetComponentByIdGet /v1/components/{id}Get a single component
ComponentsAPIGetComponentsGet /v1/componentsList components
ComponentsAPIUploadComponentPost /v1/componentsUpload a single component
ContentSelectorsAPICreateContentSelectorPost /v1/security/content-selectorsCreate a new content selector
ContentSelectorsAPIDeleteContentSelectorDelete /v1/security/content-selectors/{name}Delete a content selector
ContentSelectorsAPIGetContentSelectorGet /v1/security/content-selectors/{name}Get a content selector by name
ContentSelectorsAPIGetContentSelectorsGet /v1/security/content-selectorsList content selectors
ContentSelectorsAPIUpdateContentSelectorPut /v1/security/content-selectors/{name}Update a content selector
EmailAPIDeleteEmailConfigurationDelete /v1/emailDisable and clear the email configuration
EmailAPIGetEmailConfigurationGet /v1/emailRetrieve the current email configuration
EmailAPISetEmailConfigurationPut /v1/emailSet the current email configuration
EmailAPITestEmailConfigurationPost /v1/email/verifySend a test email to the email address provided in the request body
FormatsAPIGet1Get /v1/formats/{format}/upload-specsGet upload field requirements for the desired format
FormatsAPIGet2Get /v1/formats/upload-specsGet upload field requirements for each supported format
LifecycleAPIBouncePut /v1/lifecycle/bounceBounce lifecycle phase
LifecycleAPIGetPhaseGet /v1/lifecycle/phaseGet current lifecycle phase
LifecycleAPISetPhasePut /v1/lifecycle/phaseMove to new lifecycle phase
MaliciousRiskOnDiskAPIGetEnabledRegistriesGet /v1/malicious-risk/enabledRegistriesGet RHC Enabled registries for malicious risk scanning.
MaliciousRiskOnDiskAPIGetMaliciousRiskOnDiskCountGet /v1/malicious-risk/risk-on-diskGet Malicious Risk On Disk Count
ManageSonatypeHTTPSystemSettingsAPIGetHttpSettingsGet /v1/httpGet HTTP system settings
ManageSonatypeHTTPSystemSettingsAPIResetHttpSettingsDelete /v1/httpReset HTTP System Settings
ManageSonatypeHTTPSystemSettingsAPIUpdateHttpSettingsPut /v1/httpUpdate HTTP system settings
ManageSonatypeRepositoryFirewallConfigurationAPIDisableIqPost /v1/iq/disableDisable Sonatype Repository Firewall
ManageSonatypeRepositoryFirewallConfigurationAPIEnableIqPost /v1/iq/enableEnable Sonatype Repository Firewall
ManageSonatypeRepositoryFirewallConfigurationAPIGetAllAuditStatusGet /v1/iq/auditList repositories audit statuses.
ManageSonatypeRepositoryFirewallConfigurationAPIGetAuditStatusGet /v1/iq/audit/{repositoryName}Get audit status for the repository
ManageSonatypeRepositoryFirewallConfigurationAPIGetConfigurationGet /v1/iqGet Sonatype Repository Firewall configuration
ManageSonatypeRepositoryFirewallConfigurationAPIManageAuditPut /v1/iq/auditManage audit
ManageSonatypeRepositoryFirewallConfigurationAPIUpdateConfigurationPut /v1/iqUpdate Sonatype Repository Firewall configuration
ManageSonatypeRepositoryFirewallConfigurationAPIVerifyConnectionPost /v1/iq/verify-connectionVerify Sonatype Repository Firewall connection
ProductLicensingAPIGetLicenseStatusGet /v1/system/licenseGet the current license status.
ProductLicensingAPIRemoveLicenseDelete /v1/system/licenseUninstall license if present.
ProductLicensingAPISetLicensePost /v1/system/licenseUpload a new license file.
ReadOnlyAPIForceReleasePost /v1/read-only/force-releaseForcibly release read-only and allow changes to embedded OrientDB
ReadOnlyAPIFreezePost /v1/read-only/freezePrevent changes to embedded OrientDB
ReadOnlyAPIGetGet /v1/read-onlyGet read-only state
ReadOnlyAPIReleasePost /v1/read-only/releaseRelease read-only and allow changes to embedded OrientDB
RepositoryManagementAPICreateAptHostedRepositoryPost /v1/repositories/apt/hostedCreate APT hosted repository
RepositoryManagementAPICreateAptProxyRepositoryPost /v1/repositories/apt/proxyCreate APT proxy repository
RepositoryManagementAPICreateCargoGroupRepositoryPost /v1/repositories/cargo/groupCreate cargo group repository
RepositoryManagementAPICreateCargoHostedRepositoryPost /v1/repositories/cargo/hostedCreate cargo hosted repository
RepositoryManagementAPICreateCargoProxyRepositoryPost /v1/repositories/cargo/proxyCreate cargo proxy repository
RepositoryManagementAPICreateCocoapodsProxyRepositoryPost /v1/repositories/cocoapods/proxyCreate Cocoapods proxy repository
RepositoryManagementAPICreateConanHostedRepositoryPost /v1/repositories/conan/hostedCreate Conan hosted repository
RepositoryManagementAPICreateConanProxyRepositoryPost /v1/repositories/conan/proxyCreate Conan proxy repository
RepositoryManagementAPICreateCondaProxyRepositoryPost /v1/repositories/conda/proxyCreate conda proxy repository
RepositoryManagementAPICreateDockerGroupRepositoryPost /v1/repositories/docker/groupCreate Docker group repository
RepositoryManagementAPICreateDockerHostedRepositoryPost /v1/repositories/docker/hostedCreate Docker hosted repository
RepositoryManagementAPICreateDockerProxyRepositoryPost /v1/repositories/docker/proxyCreate Docker proxy repository
RepositoryManagementAPICreateGitlfsHostedRepositoryPost /v1/repositories/gitlfs/hostedCreate Git LFS hosted repository
RepositoryManagementAPICreateGoGroupRepositoryPost /v1/repositories/go/groupCreate a Go group repository
RepositoryManagementAPICreateGoProxyRepositoryPost /v1/repositories/go/proxyCreate a Go proxy repository
RepositoryManagementAPICreateHelmHostedRepositoryPost /v1/repositories/helm/hostedCreate Helm hosted repository
RepositoryManagementAPICreateHelmProxyRepositoryPost /v1/repositories/helm/proxyCreate Helm proxy repository
RepositoryManagementAPICreateMavenGroupRepositoryPost /v1/repositories/maven/groupCreate Maven group repository
RepositoryManagementAPICreateMavenHostedRepositoryPost /v1/repositories/maven/hostedCreate Maven hosted repository
RepositoryManagementAPICreateMavenProxyRepositoryPost /v1/repositories/maven/proxyCreate Maven proxy repository
RepositoryManagementAPICreateNpmGroupRepositoryPost /v1/repositories/npm/groupCreate npm group repository
RepositoryManagementAPICreateNpmHostedRepositoryPost /v1/repositories/npm/hostedCreate npm hosted repository
RepositoryManagementAPICreateNpmProxyRepositoryPost /v1/repositories/npm/proxyCreate npm proxy repository
RepositoryManagementAPICreateNugetGroupRepositoryPost /v1/repositories/nuget/groupCreate NuGet group repository
RepositoryManagementAPICreateNugetHostedRepositoryPost /v1/repositories/nuget/hostedCreate NuGet hosted repository
RepositoryManagementAPICreateNugetProxyRepositoryPost /v1/repositories/nuget/proxyCreate NuGet proxy repository
RepositoryManagementAPICreateP2ProxyRepositoryPost /v1/repositories/p2/proxyCreate p2 proxy repository
RepositoryManagementAPICreatePypiGroupRepositoryPost /v1/repositories/pypi/groupCreate PyPI group repository
RepositoryManagementAPICreatePypiHostedRepositoryPost /v1/repositories/pypi/hostedCreate PyPI hosted repository
RepositoryManagementAPICreatePypiProxyRepositoryPost /v1/repositories/pypi/proxyCreate PyPI proxy repository
RepositoryManagementAPICreateRGroupRepositoryPost /v1/repositories/r/groupCreate R group repository
RepositoryManagementAPICreateRHostedRepositoryPost /v1/repositories/r/hostedCreate R hosted repository
RepositoryManagementAPICreateRProxyRepositoryPost /v1/repositories/r/proxyCreate R proxy repository
RepositoryManagementAPICreateRawGroupRepositoryPost /v1/repositories/raw/groupCreate raw group repository
RepositoryManagementAPICreateRawHostedRepositoryPost /v1/repositories/raw/hostedCreate raw hosted repository
RepositoryManagementAPICreateRawProxyRepositoryPost /v1/repositories/raw/proxyCreate raw proxy repository
RepositoryManagementAPICreateRubygemsGroupRepositoryPost /v1/repositories/rubygems/groupCreate RubyGems group repository
RepositoryManagementAPICreateRubygemsHostedRepositoryPost /v1/repositories/rubygems/hostedCreate RubyGems hosted repository
RepositoryManagementAPICreateRubygemsProxyRepositoryPost /v1/repositories/rubygems/proxyCreate RubyGems proxy repository
RepositoryManagementAPICreateYumGroupRepositoryPost /v1/repositories/yum/groupCreate Yum group repository
RepositoryManagementAPICreateYumHostedRepositoryPost /v1/repositories/yum/hostedCreate Yum hosted repository
RepositoryManagementAPICreateYumProxyRepositoryPost /v1/repositories/yum/proxyCreate Yum proxy repository
RepositoryManagementAPICreaterepositorynameHealthCheckRepositoryPost /v1/repositories/{repositoryName}/health-checkEnable repository health check. Proxy repositories only.
RepositoryManagementAPICreaterepositorynameInvalidateCacheRepositoryPost /v1/repositories/{repositoryName}/invalidate-cacheInvalidate repository cache. Proxy or group repositories only.
RepositoryManagementAPICreaterepositorynameRebuildIndexRepositoryPost /v1/repositories/{repositoryName}/rebuild-indexSchedule a 'Repair - Rebuild repository search' Task. Hosted or proxy repositories only.
RepositoryManagementAPIDeleteRepositoryDelete /v1/repositories/{repositoryName}Delete repository of any format
RepositoryManagementAPIDisableRepositoryHealthCheckDelete /v1/repositories/{repositoryName}/health-checkDisable repository health check. Proxy repositories only.
RepositoryManagementAPIGetAllRepositoriesGet /v1/repositoriesList repositories
RepositoryManagementAPIGetAptHostedRepositoryGet /v1/repositories/apt/hosted/{repositoryName}Get repository
RepositoryManagementAPIGetAptProxyRepositoryGet /v1/repositories/apt/proxy/{repositoryName}Get repository
RepositoryManagementAPIGetCargoGroupRepositoryGet /v1/repositories/cargo/group/{repositoryName}Get repository
RepositoryManagementAPIGetCargoHostedRepositoryGet /v1/repositories/cargo/hosted/{repositoryName}Get repository
RepositoryManagementAPIGetCargoProxyRepositoryGet /v1/repositories/cargo/proxy/{repositoryName}Get repository
RepositoryManagementAPIGetCocoapodsProxyRepositoryGet /v1/repositories/cocoapods/proxy/{repositoryName}Get repository
RepositoryManagementAPIGetConanHostedRepositoryGet /v1/repositories/conan/hosted/{repositoryName}Get repository
RepositoryManagementAPIGetConanProxyRepositoryGet /v1/repositories/conan/proxy/{repositoryName}Get repository
RepositoryManagementAPIGetCondaProxyRepositoryGet /v1/repositories/conda/proxy/{repositoryName}Get repository
RepositoryManagementAPIGetDockerGroupRepositoryGet /v1/repositories/docker/group/{repositoryName}Get repository
RepositoryManagementAPIGetDockerHostedRepositoryGet /v1/repositories/docker/hosted/{repositoryName}Get repository
RepositoryManagementAPIGetDockerProxyRepositoryGet /v1/repositories/docker/proxy/{repositoryName}Get repository
RepositoryManagementAPIGetGitlfsHostedRepositoryGet /v1/repositories/gitlfs/hosted/{repositoryName}Get repository
RepositoryManagementAPIGetGoGroupRepositoryGet /v1/repositories/go/group/{repositoryName}Get repository
RepositoryManagementAPIGetGoProxyRepositoryGet /v1/repositories/go/proxy/{repositoryName}Get repository
RepositoryManagementAPIGetHelmHostedRepositoryGet /v1/repositories/helm/hosted/{repositoryName}Get repository
RepositoryManagementAPIGetHelmProxyRepositoryGet /v1/repositories/helm/proxy/{repositoryName}Get repository
RepositoryManagementAPIGetMavenGroupRepositoryGet /v1/repositories/maven/group/{repositoryName}Get repository
RepositoryManagementAPIGetMavenHostedRepositoryGet /v1/repositories/maven/hosted/{repositoryName}Get repository
RepositoryManagementAPIGetMavenProxyRepositoryGet /v1/repositories/maven/proxy/{repositoryName}Get repository
RepositoryManagementAPIGetNpmGroupRepositoryGet /v1/repositories/npm/group/{repositoryName}Get repository
RepositoryManagementAPIGetNpmHostedRepositoryGet /v1/repositories/npm/hosted/{repositoryName}Get repository
RepositoryManagementAPIGetNpmProxyRepositoryGet /v1/repositories/npm/proxy/{repositoryName}Get repository
RepositoryManagementAPIGetNugetGroupRepositoryGet /v1/repositories/nuget/group/{repositoryName}Get repository
RepositoryManagementAPIGetNugetHostedRepositoryGet /v1/repositories/nuget/hosted/{repositoryName}Get repository
RepositoryManagementAPIGetNugetProxyRepositoryGet /v1/repositories/nuget/proxy/{repositoryName}Get repository
RepositoryManagementAPIGetP2ProxyRepositoryGet /v1/repositories/p2/proxy/{repositoryName}Get repository
RepositoryManagementAPIGetPypiGroupRepositoryGet /v1/repositories/pypi/group/{repositoryName}Get repository
RepositoryManagementAPIGetPypiHostedRepositoryGet /v1/repositories/pypi/hosted/{repositoryName}Get repository
RepositoryManagementAPIGetPypiProxyRepositoryGet /v1/repositories/pypi/proxy/{repositoryName}Get repository
RepositoryManagementAPIGetRGroupRepositoryGet /v1/repositories/r/group/{repositoryName}Get repository
RepositoryManagementAPIGetRHostedRepositoryGet /v1/repositories/r/hosted/{repositoryName}Get repository
RepositoryManagementAPIGetRProxyRepositoryGet /v1/repositories/r/proxy/{repositoryName}Get repository
RepositoryManagementAPIGetRawGroupRepositoryGet /v1/repositories/raw/group/{repositoryName}Get repository
RepositoryManagementAPIGetRawHostedRepositoryGet /v1/repositories/raw/hosted/{repositoryName}Get repository
RepositoryManagementAPIGetRawProxyRepositoryGet /v1/repositories/raw/proxy/{repositoryName}Get repository
RepositoryManagementAPIGetRepositoriesGet /v1/repositorySettingsList repositories
RepositoryManagementAPIGetRepositoryGet /v1/repositories/{repositoryName}Get repository details
RepositoryManagementAPIGetRubygemsGroupRepositoryGet /v1/repositories/rubygems/group/{repositoryName}Get repository
RepositoryManagementAPIGetRubygemsHostedRepositoryGet /v1/repositories/rubygems/hosted/{repositoryName}Get repository
RepositoryManagementAPIGetRubygemsProxyRepositoryGet /v1/repositories/rubygems/proxy/{repositoryName}Get repository
RepositoryManagementAPIGetYumGroupRepositoryGet /v1/repositories/yum/group/{repositoryName}Get repository
RepositoryManagementAPIGetYumHostedRepositoryGet /v1/repositories/yum/hosted/{repositoryName}Get repository
RepositoryManagementAPIGetYumProxyRepositoryGet /v1/repositories/yum/proxy/{repositoryName}Get repository
RepositoryManagementAPIUpdateAptHostedRepositoryPut /v1/repositories/apt/hosted/{repositoryName}Update APT hosted repository
RepositoryManagementAPIUpdateAptProxyRepositoryPut /v1/repositories/apt/proxy/{repositoryName}Update APT proxy repository
RepositoryManagementAPIUpdateCargoGroupRepositoryPut /v1/repositories/cargo/group/{repositoryName}Update cargo group repository
RepositoryManagementAPIUpdateCargoHostedRepositoryPut /v1/repositories/cargo/hosted/{repositoryName}Update cargo hosted repository
RepositoryManagementAPIUpdateCargoProxyRepositoryPut /v1/repositories/cargo/proxy/{repositoryName}Update cargo proxy repository
RepositoryManagementAPIUpdateCocoapodsProxyRepositoryPut /v1/repositories/cocoapods/proxy/{repositoryName}Update Cocoapods proxy repository
RepositoryManagementAPIUpdateConanHostedRepositoryPut /v1/repositories/conan/hosted/{repositoryName}Update Conan hosted repository
RepositoryManagementAPIUpdateConanProxyRepositoryPut /v1/repositories/conan/proxy/{repositoryName}Update Conan proxy repository
RepositoryManagementAPIUpdateCondaProxyRepositoryPut /v1/repositories/conda/proxy/{repositoryName}Update conda proxy repository
RepositoryManagementAPIUpdateDockerGroupRepositoryPut /v1/repositories/docker/group/{repositoryName}Update Docker group repository
RepositoryManagementAPIUpdateDockerHostedRepositoryPut /v1/repositories/docker/hosted/{repositoryName}Update Docker hosted repository
RepositoryManagementAPIUpdateDockerProxyRepositoryPut /v1/repositories/docker/proxy/{repositoryName}Update Docker proxy repository
RepositoryManagementAPIUpdateGitlfsHostedRepositoryPut /v1/repositories/gitlfs/hosted/{repositoryName}Update Git LFS hosted repository
RepositoryManagementAPIUpdateGoGroupRepositoryPut /v1/repositories/go/group/{repositoryName}Update a Go group repository
RepositoryManagementAPIUpdateGoProxyRepositoryPut /v1/repositories/go/proxy/{repositoryName}Update a Go proxy repository
RepositoryManagementAPIUpdateHelmHostedRepositoryPut /v1/repositories/helm/hosted/{repositoryName}Update Helm hosted repository
RepositoryManagementAPIUpdateHelmProxyRepositoryPut /v1/repositories/helm/proxy/{repositoryName}Update Helm proxy repository
RepositoryManagementAPIUpdateMavenGroupRepositoryPut /v1/repositories/maven/group/{repositoryName}Update Maven group repository
RepositoryManagementAPIUpdateMavenHostedRepositoryPut /v1/repositories/maven/hosted/{repositoryName}Update Maven hosted repository
RepositoryManagementAPIUpdateMavenProxyRepositoryPut /v1/repositories/maven/proxy/{repositoryName}Update Maven proxy repository
RepositoryManagementAPIUpdateNpmGroupRepositoryPut /v1/repositories/npm/group/{repositoryName}Update npm group repository
RepositoryManagementAPIUpdateNpmHostedRepositoryPut /v1/repositories/npm/hosted/{repositoryName}Update npm hosted repository
RepositoryManagementAPIUpdateNpmProxyRepositoryPut /v1/repositories/npm/proxy/{repositoryName}Update npm proxy repository
RepositoryManagementAPIUpdateNugetGroupRepositoryPut /v1/repositories/nuget/group/{repositoryName}Update NuGet group repository
RepositoryManagementAPIUpdateNugetHostedRepositoryPut /v1/repositories/nuget/hosted/{repositoryName}Update NuGet hosted repository
RepositoryManagementAPIUpdateNugetProxyRepositoryPut /v1/repositories/nuget/proxy/{repositoryName}Update NuGet proxy repository
RepositoryManagementAPIUpdateP2ProxyRepositoryPut /v1/repositories/p2/proxy/{repositoryName}Update p2 proxy repository
RepositoryManagementAPIUpdatePypiGroupRepositoryPut /v1/repositories/pypi/group/{repositoryName}Update PyPI group repository
RepositoryManagementAPIUpdatePypiHostedRepositoryPut /v1/repositories/pypi/hosted/{repositoryName}Update PyPI hosted repository
RepositoryManagementAPIUpdatePypiProxyRepositoryPut /v1/repositories/pypi/proxy/{repositoryName}Update PyPI proxy repository
RepositoryManagementAPIUpdateRGroupRepositoryPut /v1/repositories/r/group/{repositoryName}Update R group repository
RepositoryManagementAPIUpdateRHostedRepositoryPut /v1/repositories/r/hosted/{repositoryName}Update R hosted repository
RepositoryManagementAPIUpdateRProxyRepositoryPut /v1/repositories/r/proxy/{repositoryName}Update R proxy repository
RepositoryManagementAPIUpdateRawGroupRepositoryPut /v1/repositories/raw/group/{repositoryName}Update raw group repository
RepositoryManagementAPIUpdateRawHostedRepositoryPut /v1/repositories/raw/hosted/{repositoryName}Update raw hosted repository
RepositoryManagementAPIUpdateRawProxyRepositoryPut /v1/repositories/raw/proxy/{repositoryName}Update raw proxy repository
RepositoryManagementAPIUpdateRubygemsGroupRepositoryPut /v1/repositories/rubygems/group/{repositoryName}Update RubyGems group repository
RepositoryManagementAPIUpdateRubygemsHostedRepositoryPut /v1/repositories/rubygems/hosted/{repositoryName}Update RubyGems hosted repository
RepositoryManagementAPIUpdateRubygemsProxyRepositoryPut /v1/repositories/rubygems/proxy/{repositoryName}Update RubyGems proxy repository
RepositoryManagementAPIUpdateYumGroupRepositoryPut /v1/repositories/yum/group/{repositoryName}Update Yum group repository
RepositoryManagementAPIUpdateYumHostedRepositoryPut /v1/repositories/yum/hosted/{repositoryName}Update Yum hosted repository
RepositoryManagementAPIUpdateYumProxyRepositoryPut /v1/repositories/yum/proxy/{repositoryName}Update Yum proxy repository
RoutingRulesAPICreateRoutingRulePost /v1/routing-rulesCreate a single routing rule
RoutingRulesAPIDeleteRoutingRuleDelete /v1/routing-rules/{name}Delete a single routing rule
RoutingRulesAPIGetRoutingRuleGet /v1/routing-rules/{name}Get a single routing rule
RoutingRulesAPIGetRoutingRulesGet /v1/routing-rulesList routing rules
RoutingRulesAPIUpdateRoutingRulePut /v1/routing-rules/{name}Update a single routing rule
ScriptAPIAddPost /v1/scriptAdd a new script
ScriptAPIBrowseGet /v1/scriptList all stored scripts
ScriptAPIDelete1Delete /v1/script/{name}Delete stored script by name
ScriptAPIEditPut /v1/script/{name}Update stored script by name
ScriptAPIRead1Get /v1/script/{name}Read stored script by name
ScriptAPIRun1Post /v1/script/{name}/runRun stored script by name
SearchAPISearchGet /v1/searchSearch components
SearchAPISearchAndDownloadAssetsGet /v1/search/assets/downloadSearch and download asset
SearchAPISearchAssetsGet /v1/search/assetsSearch assets
SecurityAtlassianCrowdAPIClearCachePost /v1/security/atlassian-crowd/clear-cacheClear Atlassian Crowd cache
SecurityAtlassianCrowdAPIReadSettingsGet /v1/security/atlassian-crowdRetrieve Atlassian Crowd settings configured in Nexus Repository Manager
SecurityAtlassianCrowdAPIUpdateSettingsPut /v1/security/atlassian-crowdUpdate Atlassian Crowd settings configured in Nexus Repository Manager
SecurityAtlassianCrowdAPIVerifyConnection1Post /v1/security/atlassian-crowd/verify-connectionVerify connection using supplied Atlassian Crowd settings
SecurityCertificatesAPIAddCertificatePost /v1/security/ssl/truststoreAdd a certificate to the trust store.
SecurityCertificatesAPIGetTrustStoreCertificatesGet /v1/security/ssl/truststoreRetrieve a list of certificates added to the trust store.
SecurityCertificatesAPIRemoveCertificateDelete /v1/security/ssl/truststore/{id}Remove a certificate in the trust store.
SecurityCertificatesAPIRetrieveCertificateGet /v1/security/sslHelper method to retrieve certificate details from a remote system.
SecurityManagementAPIGetUserSourcesGet /v1/security/user-sourcesRetrieve a list of the available user sources.
SecurityManagementAnonymousAccessAPIReadGet /v1/security/anonymousGet Anonymous Access settings
SecurityManagementAnonymousAccessAPIUpdatePut /v1/security/anonymousUpdate Anonymous Access settings
SecurityManagementJWTAPIResetSecretPut /v1/security/jwtReset JWT secret (note that session will be expired for the all logged-in users)
SecurityManagementLDAPAPIChangeOrderPost /v1/security/ldap/change-orderChange LDAP server order
SecurityManagementLDAPAPICreateLdapServerPost /v1/security/ldapCreate LDAP server
SecurityManagementLDAPAPIDeleteLdapServerDelete /v1/security/ldap/{name}Delete LDAP server
SecurityManagementLDAPAPIGetLdapServerGet /v1/security/ldap/{name}Get LDAP server
SecurityManagementLDAPAPIGetLdapServersGet /v1/security/ldapList LDAP servers
SecurityManagementLDAPAPIUpdateLdapServerPut /v1/security/ldap/{name}Update LDAP server
SecurityManagementPrivilegesAPICreatePrivilegePost /v1/security/privileges/applicationCreate an application type privilege.
SecurityManagementPrivilegesAPICreatePrivilege1Post /v1/security/privileges/wildcardCreate a wildcard type privilege.
SecurityManagementPrivilegesAPICreatePrivilege2Post /v1/security/privileges/repository-content-selectorCreate a repository content selector type privilege.
SecurityManagementPrivilegesAPICreatePrivilege3Post /v1/security/privileges/repository-adminCreate a repository admin type privilege.
SecurityManagementPrivilegesAPICreatePrivilege4Post /v1/security/privileges/repository-viewCreate a repository view type privilege.
SecurityManagementPrivilegesAPICreatePrivilege5Post /v1/security/privileges/scriptCreate a script type privilege.
SecurityManagementPrivilegesAPIDeletePrivilegeDelete /v1/security/privileges/{privilegeName}Delete a privilege by name.
SecurityManagementPrivilegesAPIGetPrivilegeGet /v1/security/privileges/{privilegeName}Retrieve a privilege by name.
SecurityManagementPrivilegesAPIGetPrivilegesGet /v1/security/privilegesRetrieve a list of privileges.
SecurityManagementPrivilegesAPIUpdatePrivilegePut /v1/security/privileges/application/{privilegeName}Update an application type privilege.
SecurityManagementPrivilegesAPIUpdatePrivilege1Put /v1/security/privileges/wildcard/{privilegeName}Update a wildcard type privilege.
SecurityManagementPrivilegesAPIUpdatePrivilege2Put /v1/security/privileges/repository-view/{privilegeName}Update a repository view type privilege.
SecurityManagementPrivilegesAPIUpdatePrivilege3Put /v1/security/privileges/repository-content-selector/{privilegeName}Update a repository content selector type privilege.
SecurityManagementPrivilegesAPIUpdatePrivilege4Put /v1/security/privileges/repository-admin/{privilegeName}Update a repository admin type privilege.
SecurityManagementPrivilegesAPIUpdatePrivilege5Put /v1/security/privileges/script/{privilegeName}Update a script type privilege.
SecurityManagementRealmsAPIGetActiveRealmsGet /v1/security/realms/activeList the active realm IDs in order
SecurityManagementRealmsAPIGetRealmsGet /v1/security/realms/availableList the available realms
SecurityManagementRealmsAPISetActiveRealmsPut /v1/security/realms/activeSet the active security realms in the order they should be used
SecurityManagementRolesAPICreatePost /v1/security/rolesCreate role
SecurityManagementRolesAPIDeleteDelete /v1/security/roles/{id}Delete role
SecurityManagementRolesAPIGetRoleGet /v1/security/roles/{id}Get role
SecurityManagementRolesAPIGetRolesGet /v1/security/rolesList roles
SecurityManagementRolesAPIUpdate1Put /v1/security/roles/{id}Update role
SecurityManagementSAMLAPIDeleteSamlConfigurationDelete /v1/security/samlDelete SAML configuration
SecurityManagementSAMLAPIGetMetadataGet /v1/security/saml/metadataGet service provider metadata XML document
SecurityManagementSAMLAPIGetPublicCertificateInPemFormatGet /v1/security/saml/pemGet service provider signing certificate in PEM format
SecurityManagementSAMLAPIGetSamlConfigurationGet /v1/security/samlGet SAML configuration
SecurityManagementSAMLAPIPutSamlConfigurationPut /v1/security/samlCreate or update SAML configuration
SecurityManagementSecretsEncryptionAPIReEncryptPut /v1/secrets/encryption/re-encryptRe-encrypt secrets using the specified key
SecurityManagementUserTokensAPIResetAllUserTokensDelete /v1/security/user-tokensInvalidate all existing user tokens.
SecurityManagementUserTokensAPIServiceStatusGet /v1/security/user-tokensShow if the user token capability is enabled or not
SecurityManagementUserTokensAPISetServiceStatusPut /v1/security/user-tokensEnable/Disable the user token capability
SecurityManagementUsersAPIChangePasswordPut /v1/security/users/{userId}/change-passwordChange a user's password.
SecurityManagementUsersAPICreateUserPost /v1/security/usersCreate a new user in the default source.
SecurityManagementUsersAPIDeleteUserDelete /v1/security/users/{userId}Delete a user.
SecurityManagementUsersAPIGetUsersGet /v1/security/usersRetrieve a list of users.
SecurityManagementUsersAPIResetDelete /v1/security/users/{userId}/{realm}/user-token-resetReset the user token for the given user.
SecurityManagementUsersAPIUpdateUserPut /v1/security/users/{userId}Update an existing user.
StagingAPIDelete3Post /v1/staging/deleteDelete components
StagingAPIMovePost /v1/staging/move/{destination}Move components
StatusAPIGetClusterSystemStatusChecksGet /beta/status/check/clusterHealth check endpoint that returns the results of the system status checks
StatusAPIGetNodeSystemStatusChecksGet /beta/status/check/{nodeId}Health check endpoint that returns the results of the system status checks of specified Node
StatusAPIGetSystemStatusChecksGet /v1/status/checkHealth check endpoint that returns the results of the system status checks
StatusAPIIsAvailableGet /v1/statusHealth check endpoint that validates server can respond to read requests
StatusAPIIsWritableGet /v1/status/writableHealth check endpoint that validates server can respond to read and write requests
SupportAPISupportzipPost /v1/support/supportzipCreates and downloads a support zip
SupportAPISupportzippathPost /v1/support/supportzippathCreates a support zip and returns the path
SystemNodesAPIClearDelete /v1/system/nodeReset the ID for this node. Takes effect after restart and should only be used when cloning an instance
SystemNodesAPIGetNodeIdGet /v1/system/nodeGet information about this node
SystemNodesAPIGetSystemInformationGet /beta/system/informationGet information about all nodes
TagsAPIAssociatePost /v1/tags/associate/{tagName}Associate components with a tag
TagsAPICreate1Post /v1/tagsCreate a tag
TagsAPIDelete2Delete /v1/tags/{name}Delete a tag
TagsAPIDisassociateDelete /v1/tags/associate/{tagName}Disassociate components from a tag
TagsAPIGet3Get /v1/tags/{name}Get a tag
TagsAPIGetTagsGet /v1/tagsList tags
TagsAPIReplacePut /v1/tags/{name}Update a tags attributes
TasksAPICreateTaskPost /v1/tasksCreate task
TasksAPIDeleteTaskByIdDelete /v1/tasks/{id}Delete task by id
TasksAPIGetTaskByIdGet /v1/tasks/{id}Get a single task by id
TasksAPIGetTaskTemplateGet /v1/tasks/templates/{typeId}Get task template by type. This is the base to create new tasks
TasksAPIGetTaskTemplatesGet /v1/tasks/templatesList tasks of template tasks. This is the base to create new tasks
TasksAPIGetTasksGet /v1/tasksList tasks
TasksAPIRunPost /v1/tasks/{id}/runRun task
TasksAPIStopPost /v1/tasks/{id}/stopStop task
TasksAPIUpdateTaskPut /v1/tasks/{taskId}Update an existing task

Documentation For Models

Documentation For Authorization

Authentication schemes defined for the API:

BasicAuth

  • Type: HTTP basic authentication

Example

auth := context.WithValue(context.Background(), sonatyperepo.ContextBasicAuth, sonatyperepo.BasicAuth{
	UserName: "username",
	Password: "password",
})
r, err := client.Service.Operation(auth, args)

Documentation for Utility Methods

Due to the fact that model structure members are all pointers, this package contains a number of utility functions to easily obtain pointers to values of basic types. Each of these functions takes a value of the given basic type and returns a pointer to it:

  • PtrBool
  • PtrInt
  • PtrInt32
  • PtrInt64
  • PtrFloat
  • PtrFloat32
  • PtrFloat64
  • PtrString
  • PtrTime

Author