# Packages
# 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
Class | Method | HTTP request | Description |
---|---|---|---|
AssetsAPI | DeleteAsset | Delete /v1/assets/{id} | Delete a single asset |
AssetsAPI | GetAssetById | Get /v1/assets/{id} | Get a single asset |
AssetsAPI | GetAssets | Get /v1/assets | List assets |
AzureBlobStoreAPI | VerifyConnection2 | Post /v1/azureblobstore/test-connection | Verify connection using supplied Azure Blob Store settings |
BlobStoreAPI | ConvertBlobStoreToGroup | Post /v1/blobstores/group/convert/{name}/{newNameForOriginal} | Convert a blob store to a group blob store |
BlobStoreAPI | CreateBlobStore1 | Post /v1/blobstores/azure | Create an Azure blob store |
BlobStoreAPI | CreateBlobStore2 | Post /v1/blobstores/google | Create a Google Cloud blob store |
BlobStoreAPI | CreateFileBlobStore | Post /v1/blobstores/file | Create a file blob store |
BlobStoreAPI | CreateGroupBlobStore | Post /v1/blobstores/group | Create a group blob store |
BlobStoreAPI | CreateS3BlobStore | Post /v1/blobstores/s3 | Create an S3 blob store |
BlobStoreAPI | DeleteBlobStore | Delete /v1/blobstores/{name} | Delete a blob store by name |
BlobStoreAPI | GetBlobStore1 | Get /v1/blobstores/azure/{name} | Get an Azure blob store configuration by name |
BlobStoreAPI | GetBlobStore2 | Get /v1/blobstores/google/{name} | Get the configuration for a Google Cloud blob store |
BlobStoreAPI | GetFileBlobStoreConfiguration | Get /v1/blobstores/file/{name} | Get a file blob store configuration by name |
BlobStoreAPI | GetGroupBlobStoreConfiguration | Get /v1/blobstores/group/{name} | Get a group blob store configuration by name |
BlobStoreAPI | GetRegionsByProjectId | Get /v1/blobstores/google/regions/{projectId} | Get the project regions by project's id |
BlobStoreAPI | GetS3BlobStore | Get /v1/blobstores/s3/{name} | Get a S3 blob store configuration by name |
BlobStoreAPI | ListBlobStores | Get /v1/blobstores | List the blob stores |
BlobStoreAPI | QuotaStatus | Get /v1/blobstores/{name}/quota-status | Get quota status for a given blob store |
BlobStoreAPI | UpdateBlobStore1 | Put /v1/blobstores/azure/{name} | Update an Azure blob store configuration by name |
BlobStoreAPI | UpdateBlobStore2 | Put /v1/blobstores/google/{name} | Update a Google Cloud blob store |
BlobStoreAPI | UpdateFileBlobStore | Put /v1/blobstores/file/{name} | Update a file blob store configuration by name |
BlobStoreAPI | UpdateGroupBlobStore | Put /v1/blobstores/group/{name} | Update a group blob store configuration by name |
BlobStoreAPI | UpdateS3BlobStore | Put /v1/blobstores/s3/{name} | Update an S3 blob store configuration by name |
CleanupPoliciesAPI | Create2 | Post /v1/cleanup-policies | Create a new policy |
CleanupPoliciesAPI | DeletePolicyByName | Delete /v1/cleanup-policies/{name} | Delete cleanup policy |
CleanupPoliciesAPI | GetAll | Get /v1/cleanup-policies | Get a list of existing policies |
CleanupPoliciesAPI | GetCleanupPolicyByName | Get /v1/cleanup-policies/{name} | Get a policy by name |
CleanupPoliciesAPI | Update2 | Put /v1/cleanup-policies/{policyName} | Update existing policy |
ComponentsAPI | DeleteComponent | Delete /v1/components/{id} | Delete a single component |
ComponentsAPI | GetComponentById | Get /v1/components/{id} | Get a single component |
ComponentsAPI | GetComponents | Get /v1/components | List components |
ComponentsAPI | UploadComponent | Post /v1/components | Upload a single component |
ContentSelectorsAPI | CreateContentSelector | Post /v1/security/content-selectors | Create a new content selector |
ContentSelectorsAPI | DeleteContentSelector | Delete /v1/security/content-selectors/{name} | Delete a content selector |
ContentSelectorsAPI | GetContentSelector | Get /v1/security/content-selectors/{name} | Get a content selector by name |
ContentSelectorsAPI | GetContentSelectors | Get /v1/security/content-selectors | List content selectors |
ContentSelectorsAPI | UpdateContentSelector | Put /v1/security/content-selectors/{name} | Update a content selector |
EmailAPI | DeleteEmailConfiguration | Delete /v1/email | Disable and clear the email configuration |
EmailAPI | GetEmailConfiguration | Get /v1/email | Retrieve the current email configuration |
EmailAPI | SetEmailConfiguration | Put /v1/email | Set the current email configuration |
EmailAPI | TestEmailConfiguration | Post /v1/email/verify | Send a test email to the email address provided in the request body |
FormatsAPI | Get1 | Get /v1/formats/{format}/upload-specs | Get upload field requirements for the desired format |
FormatsAPI | Get2 | Get /v1/formats/upload-specs | Get upload field requirements for each supported format |
LifecycleAPI | Bounce | Put /v1/lifecycle/bounce | Bounce lifecycle phase |
LifecycleAPI | GetPhase | Get /v1/lifecycle/phase | Get current lifecycle phase |
LifecycleAPI | SetPhase | Put /v1/lifecycle/phase | Move to new lifecycle phase |
MaliciousRiskOnDiskAPI | GetEnabledRegistries | Get /v1/malicious-risk/enabledRegistries | Get RHC Enabled registries for malicious risk scanning. |
MaliciousRiskOnDiskAPI | GetMaliciousRiskOnDiskCount | Get /v1/malicious-risk/risk-on-disk | Get Malicious Risk On Disk Count |
ManageSonatypeHTTPSystemSettingsAPI | GetHttpSettings | Get /v1/http | Get HTTP system settings |
ManageSonatypeHTTPSystemSettingsAPI | ResetHttpSettings | Delete /v1/http | Reset HTTP System Settings |
ManageSonatypeHTTPSystemSettingsAPI | UpdateHttpSettings | Put /v1/http | Update HTTP system settings |
ManageSonatypeRepositoryFirewallConfigurationAPI | DisableIq | Post /v1/iq/disable | Disable Sonatype Repository Firewall |
ManageSonatypeRepositoryFirewallConfigurationAPI | EnableIq | Post /v1/iq/enable | Enable Sonatype Repository Firewall |
ManageSonatypeRepositoryFirewallConfigurationAPI | GetAllAuditStatus | Get /v1/iq/audit | List repositories audit statuses. |
ManageSonatypeRepositoryFirewallConfigurationAPI | GetAuditStatus | Get /v1/iq/audit/{repositoryName} | Get audit status for the repository |
ManageSonatypeRepositoryFirewallConfigurationAPI | GetConfiguration | Get /v1/iq | Get Sonatype Repository Firewall configuration |
ManageSonatypeRepositoryFirewallConfigurationAPI | ManageAudit | Put /v1/iq/audit | Manage audit |
ManageSonatypeRepositoryFirewallConfigurationAPI | UpdateConfiguration | Put /v1/iq | Update Sonatype Repository Firewall configuration |
ManageSonatypeRepositoryFirewallConfigurationAPI | VerifyConnection | Post /v1/iq/verify-connection | Verify Sonatype Repository Firewall connection |
ProductLicensingAPI | GetLicenseStatus | Get /v1/system/license | Get the current license status. |
ProductLicensingAPI | RemoveLicense | Delete /v1/system/license | Uninstall license if present. |
ProductLicensingAPI | SetLicense | Post /v1/system/license | Upload a new license file. |
ReadOnlyAPI | ForceRelease | Post /v1/read-only/force-release | Forcibly release read-only and allow changes to embedded OrientDB |
ReadOnlyAPI | Freeze | Post /v1/read-only/freeze | Prevent changes to embedded OrientDB |
ReadOnlyAPI | Get | Get /v1/read-only | Get read-only state |
ReadOnlyAPI | Release | Post /v1/read-only/release | Release read-only and allow changes to embedded OrientDB |
RepositoryManagementAPI | CreateAptHostedRepository | Post /v1/repositories/apt/hosted | Create APT hosted repository |
RepositoryManagementAPI | CreateAptProxyRepository | Post /v1/repositories/apt/proxy | Create APT proxy repository |
RepositoryManagementAPI | CreateCargoGroupRepository | Post /v1/repositories/cargo/group | Create cargo group repository |
RepositoryManagementAPI | CreateCargoHostedRepository | Post /v1/repositories/cargo/hosted | Create cargo hosted repository |
RepositoryManagementAPI | CreateCargoProxyRepository | Post /v1/repositories/cargo/proxy | Create cargo proxy repository |
RepositoryManagementAPI | CreateCocoapodsProxyRepository | Post /v1/repositories/cocoapods/proxy | Create Cocoapods proxy repository |
RepositoryManagementAPI | CreateConanHostedRepository | Post /v1/repositories/conan/hosted | Create Conan hosted repository |
RepositoryManagementAPI | CreateConanProxyRepository | Post /v1/repositories/conan/proxy | Create Conan proxy repository |
RepositoryManagementAPI | CreateCondaProxyRepository | Post /v1/repositories/conda/proxy | Create conda proxy repository |
RepositoryManagementAPI | CreateDockerGroupRepository | Post /v1/repositories/docker/group | Create Docker group repository |
RepositoryManagementAPI | CreateDockerHostedRepository | Post /v1/repositories/docker/hosted | Create Docker hosted repository |
RepositoryManagementAPI | CreateDockerProxyRepository | Post /v1/repositories/docker/proxy | Create Docker proxy repository |
RepositoryManagementAPI | CreateGitlfsHostedRepository | Post /v1/repositories/gitlfs/hosted | Create Git LFS hosted repository |
RepositoryManagementAPI | CreateGoGroupRepository | Post /v1/repositories/go/group | Create a Go group repository |
RepositoryManagementAPI | CreateGoProxyRepository | Post /v1/repositories/go/proxy | Create a Go proxy repository |
RepositoryManagementAPI | CreateHelmHostedRepository | Post /v1/repositories/helm/hosted | Create Helm hosted repository |
RepositoryManagementAPI | CreateHelmProxyRepository | Post /v1/repositories/helm/proxy | Create Helm proxy repository |
RepositoryManagementAPI | CreateMavenGroupRepository | Post /v1/repositories/maven/group | Create Maven group repository |
RepositoryManagementAPI | CreateMavenHostedRepository | Post /v1/repositories/maven/hosted | Create Maven hosted repository |
RepositoryManagementAPI | CreateMavenProxyRepository | Post /v1/repositories/maven/proxy | Create Maven proxy repository |
RepositoryManagementAPI | CreateNpmGroupRepository | Post /v1/repositories/npm/group | Create npm group repository |
RepositoryManagementAPI | CreateNpmHostedRepository | Post /v1/repositories/npm/hosted | Create npm hosted repository |
RepositoryManagementAPI | CreateNpmProxyRepository | Post /v1/repositories/npm/proxy | Create npm proxy repository |
RepositoryManagementAPI | CreateNugetGroupRepository | Post /v1/repositories/nuget/group | Create NuGet group repository |
RepositoryManagementAPI | CreateNugetHostedRepository | Post /v1/repositories/nuget/hosted | Create NuGet hosted repository |
RepositoryManagementAPI | CreateNugetProxyRepository | Post /v1/repositories/nuget/proxy | Create NuGet proxy repository |
RepositoryManagementAPI | CreateP2ProxyRepository | Post /v1/repositories/p2/proxy | Create p2 proxy repository |
RepositoryManagementAPI | CreatePypiGroupRepository | Post /v1/repositories/pypi/group | Create PyPI group repository |
RepositoryManagementAPI | CreatePypiHostedRepository | Post /v1/repositories/pypi/hosted | Create PyPI hosted repository |
RepositoryManagementAPI | CreatePypiProxyRepository | Post /v1/repositories/pypi/proxy | Create PyPI proxy repository |
RepositoryManagementAPI | CreateRGroupRepository | Post /v1/repositories/r/group | Create R group repository |
RepositoryManagementAPI | CreateRHostedRepository | Post /v1/repositories/r/hosted | Create R hosted repository |
RepositoryManagementAPI | CreateRProxyRepository | Post /v1/repositories/r/proxy | Create R proxy repository |
RepositoryManagementAPI | CreateRawGroupRepository | Post /v1/repositories/raw/group | Create raw group repository |
RepositoryManagementAPI | CreateRawHostedRepository | Post /v1/repositories/raw/hosted | Create raw hosted repository |
RepositoryManagementAPI | CreateRawProxyRepository | Post /v1/repositories/raw/proxy | Create raw proxy repository |
RepositoryManagementAPI | CreateRubygemsGroupRepository | Post /v1/repositories/rubygems/group | Create RubyGems group repository |
RepositoryManagementAPI | CreateRubygemsHostedRepository | Post /v1/repositories/rubygems/hosted | Create RubyGems hosted repository |
RepositoryManagementAPI | CreateRubygemsProxyRepository | Post /v1/repositories/rubygems/proxy | Create RubyGems proxy repository |
RepositoryManagementAPI | CreateYumGroupRepository | Post /v1/repositories/yum/group | Create Yum group repository |
RepositoryManagementAPI | CreateYumHostedRepository | Post /v1/repositories/yum/hosted | Create Yum hosted repository |
RepositoryManagementAPI | CreateYumProxyRepository | Post /v1/repositories/yum/proxy | Create Yum proxy repository |
RepositoryManagementAPI | CreaterepositorynameHealthCheckRepository | Post /v1/repositories/{repositoryName}/health-check | Enable repository health check. Proxy repositories only. |
RepositoryManagementAPI | CreaterepositorynameInvalidateCacheRepository | Post /v1/repositories/{repositoryName}/invalidate-cache | Invalidate repository cache. Proxy or group repositories only. |
RepositoryManagementAPI | CreaterepositorynameRebuildIndexRepository | Post /v1/repositories/{repositoryName}/rebuild-index | Schedule a 'Repair - Rebuild repository search' Task. Hosted or proxy repositories only. |
RepositoryManagementAPI | DeleteRepository | Delete /v1/repositories/{repositoryName} | Delete repository of any format |
RepositoryManagementAPI | DisableRepositoryHealthCheck | Delete /v1/repositories/{repositoryName}/health-check | Disable repository health check. Proxy repositories only. |
RepositoryManagementAPI | GetAllRepositories | Get /v1/repositories | List repositories |
RepositoryManagementAPI | GetAptHostedRepository | Get /v1/repositories/apt/hosted/{repositoryName} | Get repository |
RepositoryManagementAPI | GetAptProxyRepository | Get /v1/repositories/apt/proxy/{repositoryName} | Get repository |
RepositoryManagementAPI | GetCargoGroupRepository | Get /v1/repositories/cargo/group/{repositoryName} | Get repository |
RepositoryManagementAPI | GetCargoHostedRepository | Get /v1/repositories/cargo/hosted/{repositoryName} | Get repository |
RepositoryManagementAPI | GetCargoProxyRepository | Get /v1/repositories/cargo/proxy/{repositoryName} | Get repository |
RepositoryManagementAPI | GetCocoapodsProxyRepository | Get /v1/repositories/cocoapods/proxy/{repositoryName} | Get repository |
RepositoryManagementAPI | GetConanHostedRepository | Get /v1/repositories/conan/hosted/{repositoryName} | Get repository |
RepositoryManagementAPI | GetConanProxyRepository | Get /v1/repositories/conan/proxy/{repositoryName} | Get repository |
RepositoryManagementAPI | GetCondaProxyRepository | Get /v1/repositories/conda/proxy/{repositoryName} | Get repository |
RepositoryManagementAPI | GetDockerGroupRepository | Get /v1/repositories/docker/group/{repositoryName} | Get repository |
RepositoryManagementAPI | GetDockerHostedRepository | Get /v1/repositories/docker/hosted/{repositoryName} | Get repository |
RepositoryManagementAPI | GetDockerProxyRepository | Get /v1/repositories/docker/proxy/{repositoryName} | Get repository |
RepositoryManagementAPI | GetGitlfsHostedRepository | Get /v1/repositories/gitlfs/hosted/{repositoryName} | Get repository |
RepositoryManagementAPI | GetGoGroupRepository | Get /v1/repositories/go/group/{repositoryName} | Get repository |
RepositoryManagementAPI | GetGoProxyRepository | Get /v1/repositories/go/proxy/{repositoryName} | Get repository |
RepositoryManagementAPI | GetHelmHostedRepository | Get /v1/repositories/helm/hosted/{repositoryName} | Get repository |
RepositoryManagementAPI | GetHelmProxyRepository | Get /v1/repositories/helm/proxy/{repositoryName} | Get repository |
RepositoryManagementAPI | GetMavenGroupRepository | Get /v1/repositories/maven/group/{repositoryName} | Get repository |
RepositoryManagementAPI | GetMavenHostedRepository | Get /v1/repositories/maven/hosted/{repositoryName} | Get repository |
RepositoryManagementAPI | GetMavenProxyRepository | Get /v1/repositories/maven/proxy/{repositoryName} | Get repository |
RepositoryManagementAPI | GetNpmGroupRepository | Get /v1/repositories/npm/group/{repositoryName} | Get repository |
RepositoryManagementAPI | GetNpmHostedRepository | Get /v1/repositories/npm/hosted/{repositoryName} | Get repository |
RepositoryManagementAPI | GetNpmProxyRepository | Get /v1/repositories/npm/proxy/{repositoryName} | Get repository |
RepositoryManagementAPI | GetNugetGroupRepository | Get /v1/repositories/nuget/group/{repositoryName} | Get repository |
RepositoryManagementAPI | GetNugetHostedRepository | Get /v1/repositories/nuget/hosted/{repositoryName} | Get repository |
RepositoryManagementAPI | GetNugetProxyRepository | Get /v1/repositories/nuget/proxy/{repositoryName} | Get repository |
RepositoryManagementAPI | GetP2ProxyRepository | Get /v1/repositories/p2/proxy/{repositoryName} | Get repository |
RepositoryManagementAPI | GetPypiGroupRepository | Get /v1/repositories/pypi/group/{repositoryName} | Get repository |
RepositoryManagementAPI | GetPypiHostedRepository | Get /v1/repositories/pypi/hosted/{repositoryName} | Get repository |
RepositoryManagementAPI | GetPypiProxyRepository | Get /v1/repositories/pypi/proxy/{repositoryName} | Get repository |
RepositoryManagementAPI | GetRGroupRepository | Get /v1/repositories/r/group/{repositoryName} | Get repository |
RepositoryManagementAPI | GetRHostedRepository | Get /v1/repositories/r/hosted/{repositoryName} | Get repository |
RepositoryManagementAPI | GetRProxyRepository | Get /v1/repositories/r/proxy/{repositoryName} | Get repository |
RepositoryManagementAPI | GetRawGroupRepository | Get /v1/repositories/raw/group/{repositoryName} | Get repository |
RepositoryManagementAPI | GetRawHostedRepository | Get /v1/repositories/raw/hosted/{repositoryName} | Get repository |
RepositoryManagementAPI | GetRawProxyRepository | Get /v1/repositories/raw/proxy/{repositoryName} | Get repository |
RepositoryManagementAPI | GetRepositories | Get /v1/repositorySettings | List repositories |
RepositoryManagementAPI | GetRepository | Get /v1/repositories/{repositoryName} | Get repository details |
RepositoryManagementAPI | GetRubygemsGroupRepository | Get /v1/repositories/rubygems/group/{repositoryName} | Get repository |
RepositoryManagementAPI | GetRubygemsHostedRepository | Get /v1/repositories/rubygems/hosted/{repositoryName} | Get repository |
RepositoryManagementAPI | GetRubygemsProxyRepository | Get /v1/repositories/rubygems/proxy/{repositoryName} | Get repository |
RepositoryManagementAPI | GetYumGroupRepository | Get /v1/repositories/yum/group/{repositoryName} | Get repository |
RepositoryManagementAPI | GetYumHostedRepository | Get /v1/repositories/yum/hosted/{repositoryName} | Get repository |
RepositoryManagementAPI | GetYumProxyRepository | Get /v1/repositories/yum/proxy/{repositoryName} | Get repository |
RepositoryManagementAPI | UpdateAptHostedRepository | Put /v1/repositories/apt/hosted/{repositoryName} | Update APT hosted repository |
RepositoryManagementAPI | UpdateAptProxyRepository | Put /v1/repositories/apt/proxy/{repositoryName} | Update APT proxy repository |
RepositoryManagementAPI | UpdateCargoGroupRepository | Put /v1/repositories/cargo/group/{repositoryName} | Update cargo group repository |
RepositoryManagementAPI | UpdateCargoHostedRepository | Put /v1/repositories/cargo/hosted/{repositoryName} | Update cargo hosted repository |
RepositoryManagementAPI | UpdateCargoProxyRepository | Put /v1/repositories/cargo/proxy/{repositoryName} | Update cargo proxy repository |
RepositoryManagementAPI | UpdateCocoapodsProxyRepository | Put /v1/repositories/cocoapods/proxy/{repositoryName} | Update Cocoapods proxy repository |
RepositoryManagementAPI | UpdateConanHostedRepository | Put /v1/repositories/conan/hosted/{repositoryName} | Update Conan hosted repository |
RepositoryManagementAPI | UpdateConanProxyRepository | Put /v1/repositories/conan/proxy/{repositoryName} | Update Conan proxy repository |
RepositoryManagementAPI | UpdateCondaProxyRepository | Put /v1/repositories/conda/proxy/{repositoryName} | Update conda proxy repository |
RepositoryManagementAPI | UpdateDockerGroupRepository | Put /v1/repositories/docker/group/{repositoryName} | Update Docker group repository |
RepositoryManagementAPI | UpdateDockerHostedRepository | Put /v1/repositories/docker/hosted/{repositoryName} | Update Docker hosted repository |
RepositoryManagementAPI | UpdateDockerProxyRepository | Put /v1/repositories/docker/proxy/{repositoryName} | Update Docker proxy repository |
RepositoryManagementAPI | UpdateGitlfsHostedRepository | Put /v1/repositories/gitlfs/hosted/{repositoryName} | Update Git LFS hosted repository |
RepositoryManagementAPI | UpdateGoGroupRepository | Put /v1/repositories/go/group/{repositoryName} | Update a Go group repository |
RepositoryManagementAPI | UpdateGoProxyRepository | Put /v1/repositories/go/proxy/{repositoryName} | Update a Go proxy repository |
RepositoryManagementAPI | UpdateHelmHostedRepository | Put /v1/repositories/helm/hosted/{repositoryName} | Update Helm hosted repository |
RepositoryManagementAPI | UpdateHelmProxyRepository | Put /v1/repositories/helm/proxy/{repositoryName} | Update Helm proxy repository |
RepositoryManagementAPI | UpdateMavenGroupRepository | Put /v1/repositories/maven/group/{repositoryName} | Update Maven group repository |
RepositoryManagementAPI | UpdateMavenHostedRepository | Put /v1/repositories/maven/hosted/{repositoryName} | Update Maven hosted repository |
RepositoryManagementAPI | UpdateMavenProxyRepository | Put /v1/repositories/maven/proxy/{repositoryName} | Update Maven proxy repository |
RepositoryManagementAPI | UpdateNpmGroupRepository | Put /v1/repositories/npm/group/{repositoryName} | Update npm group repository |
RepositoryManagementAPI | UpdateNpmHostedRepository | Put /v1/repositories/npm/hosted/{repositoryName} | Update npm hosted repository |
RepositoryManagementAPI | UpdateNpmProxyRepository | Put /v1/repositories/npm/proxy/{repositoryName} | Update npm proxy repository |
RepositoryManagementAPI | UpdateNugetGroupRepository | Put /v1/repositories/nuget/group/{repositoryName} | Update NuGet group repository |
RepositoryManagementAPI | UpdateNugetHostedRepository | Put /v1/repositories/nuget/hosted/{repositoryName} | Update NuGet hosted repository |
RepositoryManagementAPI | UpdateNugetProxyRepository | Put /v1/repositories/nuget/proxy/{repositoryName} | Update NuGet proxy repository |
RepositoryManagementAPI | UpdateP2ProxyRepository | Put /v1/repositories/p2/proxy/{repositoryName} | Update p2 proxy repository |
RepositoryManagementAPI | UpdatePypiGroupRepository | Put /v1/repositories/pypi/group/{repositoryName} | Update PyPI group repository |
RepositoryManagementAPI | UpdatePypiHostedRepository | Put /v1/repositories/pypi/hosted/{repositoryName} | Update PyPI hosted repository |
RepositoryManagementAPI | UpdatePypiProxyRepository | Put /v1/repositories/pypi/proxy/{repositoryName} | Update PyPI proxy repository |
RepositoryManagementAPI | UpdateRGroupRepository | Put /v1/repositories/r/group/{repositoryName} | Update R group repository |
RepositoryManagementAPI | UpdateRHostedRepository | Put /v1/repositories/r/hosted/{repositoryName} | Update R hosted repository |
RepositoryManagementAPI | UpdateRProxyRepository | Put /v1/repositories/r/proxy/{repositoryName} | Update R proxy repository |
RepositoryManagementAPI | UpdateRawGroupRepository | Put /v1/repositories/raw/group/{repositoryName} | Update raw group repository |
RepositoryManagementAPI | UpdateRawHostedRepository | Put /v1/repositories/raw/hosted/{repositoryName} | Update raw hosted repository |
RepositoryManagementAPI | UpdateRawProxyRepository | Put /v1/repositories/raw/proxy/{repositoryName} | Update raw proxy repository |
RepositoryManagementAPI | UpdateRubygemsGroupRepository | Put /v1/repositories/rubygems/group/{repositoryName} | Update RubyGems group repository |
RepositoryManagementAPI | UpdateRubygemsHostedRepository | Put /v1/repositories/rubygems/hosted/{repositoryName} | Update RubyGems hosted repository |
RepositoryManagementAPI | UpdateRubygemsProxyRepository | Put /v1/repositories/rubygems/proxy/{repositoryName} | Update RubyGems proxy repository |
RepositoryManagementAPI | UpdateYumGroupRepository | Put /v1/repositories/yum/group/{repositoryName} | Update Yum group repository |
RepositoryManagementAPI | UpdateYumHostedRepository | Put /v1/repositories/yum/hosted/{repositoryName} | Update Yum hosted repository |
RepositoryManagementAPI | UpdateYumProxyRepository | Put /v1/repositories/yum/proxy/{repositoryName} | Update Yum proxy repository |
RoutingRulesAPI | CreateRoutingRule | Post /v1/routing-rules | Create a single routing rule |
RoutingRulesAPI | DeleteRoutingRule | Delete /v1/routing-rules/{name} | Delete a single routing rule |
RoutingRulesAPI | GetRoutingRule | Get /v1/routing-rules/{name} | Get a single routing rule |
RoutingRulesAPI | GetRoutingRules | Get /v1/routing-rules | List routing rules |
RoutingRulesAPI | UpdateRoutingRule | Put /v1/routing-rules/{name} | Update a single routing rule |
ScriptAPI | Add | Post /v1/script | Add a new script |
ScriptAPI | Browse | Get /v1/script | List all stored scripts |
ScriptAPI | Delete1 | Delete /v1/script/{name} | Delete stored script by name |
ScriptAPI | Edit | Put /v1/script/{name} | Update stored script by name |
ScriptAPI | Read1 | Get /v1/script/{name} | Read stored script by name |
ScriptAPI | Run1 | Post /v1/script/{name}/run | Run stored script by name |
SearchAPI | Search | Get /v1/search | Search components |
SearchAPI | SearchAndDownloadAssets | Get /v1/search/assets/download | Search and download asset |
SearchAPI | SearchAssets | Get /v1/search/assets | Search assets |
SecurityAtlassianCrowdAPI | ClearCache | Post /v1/security/atlassian-crowd/clear-cache | Clear Atlassian Crowd cache |
SecurityAtlassianCrowdAPI | ReadSettings | Get /v1/security/atlassian-crowd | Retrieve Atlassian Crowd settings configured in Nexus Repository Manager |
SecurityAtlassianCrowdAPI | UpdateSettings | Put /v1/security/atlassian-crowd | Update Atlassian Crowd settings configured in Nexus Repository Manager |
SecurityAtlassianCrowdAPI | VerifyConnection1 | Post /v1/security/atlassian-crowd/verify-connection | Verify connection using supplied Atlassian Crowd settings |
SecurityCertificatesAPI | AddCertificate | Post /v1/security/ssl/truststore | Add a certificate to the trust store. |
SecurityCertificatesAPI | GetTrustStoreCertificates | Get /v1/security/ssl/truststore | Retrieve a list of certificates added to the trust store. |
SecurityCertificatesAPI | RemoveCertificate | Delete /v1/security/ssl/truststore/{id} | Remove a certificate in the trust store. |
SecurityCertificatesAPI | RetrieveCertificate | Get /v1/security/ssl | Helper method to retrieve certificate details from a remote system. |
SecurityManagementAPI | GetUserSources | Get /v1/security/user-sources | Retrieve a list of the available user sources. |
SecurityManagementAnonymousAccessAPI | Read | Get /v1/security/anonymous | Get Anonymous Access settings |
SecurityManagementAnonymousAccessAPI | Update | Put /v1/security/anonymous | Update Anonymous Access settings |
SecurityManagementJWTAPI | ResetSecret | Put /v1/security/jwt | Reset JWT secret (note that session will be expired for the all logged-in users) |
SecurityManagementLDAPAPI | ChangeOrder | Post /v1/security/ldap/change-order | Change LDAP server order |
SecurityManagementLDAPAPI | CreateLdapServer | Post /v1/security/ldap | Create LDAP server |
SecurityManagementLDAPAPI | DeleteLdapServer | Delete /v1/security/ldap/{name} | Delete LDAP server |
SecurityManagementLDAPAPI | GetLdapServer | Get /v1/security/ldap/{name} | Get LDAP server |
SecurityManagementLDAPAPI | GetLdapServers | Get /v1/security/ldap | List LDAP servers |
SecurityManagementLDAPAPI | UpdateLdapServer | Put /v1/security/ldap/{name} | Update LDAP server |
SecurityManagementPrivilegesAPI | CreatePrivilege | Post /v1/security/privileges/application | Create an application type privilege. |
SecurityManagementPrivilegesAPI | CreatePrivilege1 | Post /v1/security/privileges/wildcard | Create a wildcard type privilege. |
SecurityManagementPrivilegesAPI | CreatePrivilege2 | Post /v1/security/privileges/repository-content-selector | Create a repository content selector type privilege. |
SecurityManagementPrivilegesAPI | CreatePrivilege3 | Post /v1/security/privileges/repository-admin | Create a repository admin type privilege. |
SecurityManagementPrivilegesAPI | CreatePrivilege4 | Post /v1/security/privileges/repository-view | Create a repository view type privilege. |
SecurityManagementPrivilegesAPI | CreatePrivilege5 | Post /v1/security/privileges/script | Create a script type privilege. |
SecurityManagementPrivilegesAPI | DeletePrivilege | Delete /v1/security/privileges/{privilegeName} | Delete a privilege by name. |
SecurityManagementPrivilegesAPI | GetPrivilege | Get /v1/security/privileges/{privilegeName} | Retrieve a privilege by name. |
SecurityManagementPrivilegesAPI | GetPrivileges | Get /v1/security/privileges | Retrieve a list of privileges. |
SecurityManagementPrivilegesAPI | UpdatePrivilege | Put /v1/security/privileges/application/{privilegeName} | Update an application type privilege. |
SecurityManagementPrivilegesAPI | UpdatePrivilege1 | Put /v1/security/privileges/wildcard/{privilegeName} | Update a wildcard type privilege. |
SecurityManagementPrivilegesAPI | UpdatePrivilege2 | Put /v1/security/privileges/repository-view/{privilegeName} | Update a repository view type privilege. |
SecurityManagementPrivilegesAPI | UpdatePrivilege3 | Put /v1/security/privileges/repository-content-selector/{privilegeName} | Update a repository content selector type privilege. |
SecurityManagementPrivilegesAPI | UpdatePrivilege4 | Put /v1/security/privileges/repository-admin/{privilegeName} | Update a repository admin type privilege. |
SecurityManagementPrivilegesAPI | UpdatePrivilege5 | Put /v1/security/privileges/script/{privilegeName} | Update a script type privilege. |
SecurityManagementRealmsAPI | GetActiveRealms | Get /v1/security/realms/active | List the active realm IDs in order |
SecurityManagementRealmsAPI | GetRealms | Get /v1/security/realms/available | List the available realms |
SecurityManagementRealmsAPI | SetActiveRealms | Put /v1/security/realms/active | Set the active security realms in the order they should be used |
SecurityManagementRolesAPI | Create | Post /v1/security/roles | Create role |
SecurityManagementRolesAPI | Delete | Delete /v1/security/roles/{id} | Delete role |
SecurityManagementRolesAPI | GetRole | Get /v1/security/roles/{id} | Get role |
SecurityManagementRolesAPI | GetRoles | Get /v1/security/roles | List roles |
SecurityManagementRolesAPI | Update1 | Put /v1/security/roles/{id} | Update role |
SecurityManagementSAMLAPI | DeleteSamlConfiguration | Delete /v1/security/saml | Delete SAML configuration |
SecurityManagementSAMLAPI | GetMetadata | Get /v1/security/saml/metadata | Get service provider metadata XML document |
SecurityManagementSAMLAPI | GetPublicCertificateInPemFormat | Get /v1/security/saml/pem | Get service provider signing certificate in PEM format |
SecurityManagementSAMLAPI | GetSamlConfiguration | Get /v1/security/saml | Get SAML configuration |
SecurityManagementSAMLAPI | PutSamlConfiguration | Put /v1/security/saml | Create or update SAML configuration |
SecurityManagementSecretsEncryptionAPI | ReEncrypt | Put /v1/secrets/encryption/re-encrypt | Re-encrypt secrets using the specified key |
SecurityManagementUserTokensAPI | ResetAllUserTokens | Delete /v1/security/user-tokens | Invalidate all existing user tokens. |
SecurityManagementUserTokensAPI | ServiceStatus | Get /v1/security/user-tokens | Show if the user token capability is enabled or not |
SecurityManagementUserTokensAPI | SetServiceStatus | Put /v1/security/user-tokens | Enable/Disable the user token capability |
SecurityManagementUsersAPI | ChangePassword | Put /v1/security/users/{userId}/change-password | Change a user's password. |
SecurityManagementUsersAPI | CreateUser | Post /v1/security/users | Create a new user in the default source. |
SecurityManagementUsersAPI | DeleteUser | Delete /v1/security/users/{userId} | Delete a user. |
SecurityManagementUsersAPI | GetUsers | Get /v1/security/users | Retrieve a list of users. |
SecurityManagementUsersAPI | Reset | Delete /v1/security/users/{userId}/{realm}/user-token-reset | Reset the user token for the given user. |
SecurityManagementUsersAPI | UpdateUser | Put /v1/security/users/{userId} | Update an existing user. |
StagingAPI | Delete3 | Post /v1/staging/delete | Delete components |
StagingAPI | Move | Post /v1/staging/move/{destination} | Move components |
StatusAPI | GetClusterSystemStatusChecks | Get /beta/status/check/cluster | Health check endpoint that returns the results of the system status checks |
StatusAPI | GetNodeSystemStatusChecks | Get /beta/status/check/{nodeId} | Health check endpoint that returns the results of the system status checks of specified Node |
StatusAPI | GetSystemStatusChecks | Get /v1/status/check | Health check endpoint that returns the results of the system status checks |
StatusAPI | IsAvailable | Get /v1/status | Health check endpoint that validates server can respond to read requests |
StatusAPI | IsWritable | Get /v1/status/writable | Health check endpoint that validates server can respond to read and write requests |
SupportAPI | Supportzip | Post /v1/support/supportzip | Creates and downloads a support zip |
SupportAPI | Supportzippath | Post /v1/support/supportzippath | Creates a support zip and returns the path |
SystemNodesAPI | Clear | Delete /v1/system/node | Reset the ID for this node. Takes effect after restart and should only be used when cloning an instance |
SystemNodesAPI | GetNodeId | Get /v1/system/node | Get information about this node |
SystemNodesAPI | GetSystemInformation | Get /beta/system/information | Get information about all nodes |
TagsAPI | Associate | Post /v1/tags/associate/{tagName} | Associate components with a tag |
TagsAPI | Create1 | Post /v1/tags | Create a tag |
TagsAPI | Delete2 | Delete /v1/tags/{name} | Delete a tag |
TagsAPI | Disassociate | Delete /v1/tags/associate/{tagName} | Disassociate components from a tag |
TagsAPI | Get3 | Get /v1/tags/{name} | Get a tag |
TagsAPI | GetTags | Get /v1/tags | List tags |
TagsAPI | Replace | Put /v1/tags/{name} | Update a tags attributes |
TasksAPI | CreateTask | Post /v1/tasks | Create task |
TasksAPI | DeleteTaskById | Delete /v1/tasks/{id} | Delete task by id |
TasksAPI | GetTaskById | Get /v1/tasks/{id} | Get a single task by id |
TasksAPI | GetTaskTemplate | Get /v1/tasks/templates/{typeId} | Get task template by type. This is the base to create new tasks |
TasksAPI | GetTaskTemplates | Get /v1/tasks/templates | List tasks of template tasks. This is the base to create new tasks |
TasksAPI | GetTasks | Get /v1/tasks | List tasks |
TasksAPI | Run | Post /v1/tasks/{id}/run | Run task |
TasksAPI | Stop | Post /v1/tasks/{id}/stop | Stop task |
TasksAPI | UpdateTask | Put /v1/tasks/{taskId} | Update an existing task |
Documentation For Models
- AbstractApiRepository
- AnonymousAccessSettingsXO
- ApiCertificate
- ApiCreateUser
- ApiEmailConfiguration
- ApiEmailValidation
- ApiLicenseDetailsXO
- ApiPrivilege
- ApiPrivilegeApplicationRequest
- ApiPrivilegeRepositoryAdminRequest
- ApiPrivilegeRepositoryContentSelectorRequest
- ApiPrivilegeRepositoryViewRequest
- ApiPrivilegeScriptRequest
- ApiPrivilegeWildcardRequest
- ApiUser
- ApiUserSource
- AptHostedApiRepository
- AptHostedRepositoriesAttributes
- AptHostedRepositoryApiRequest
- AptProxyApiRepository
- AptProxyRepositoriesAttributes
- AptProxyRepositoryApiRequest
- AptSigningRepositoriesAttributes
- AssetXO
- AuthSettingsXo
- AzureBlobStoreApiAuthentication
- AzureBlobStoreApiBucketConfiguration
- AzureBlobStoreApiModel
- AzureConnectionXO
- BaseTagXO
- BlobStoreApiSoftQuota
- BlobStoreQuotaResultXO
- CargoGroupRepositoryApiRequest
- CargoHostedRepositoryApiRequest
- CargoProxyRepositoryApiRequest
- CleanupPolicyAttributes
- CleanupPolicyResourceXO
- CocoapodsProxyRepositoryApiRequest
- ComponentAttributes
- ComponentXO
- ConanHostedRepositoryApiRequest
- ConanProxyAttributes
- ConanProxyRepositoryApiRequest
- CondaProxyRepositoryApiRequest
- ContentSelectorApiCreateRequest
- ContentSelectorApiResponse
- ContentSelectorApiUpdateRequest
- CreateLdapServerXo
- CrowdApiXO
- DockerAttributes
- DockerGroupApiRepository
- DockerGroupRepositoryApiRequest
- DockerHostedApiRepository
- DockerHostedRepositoryApiRequest
- DockerHostedStorageAttributes
- DockerProxyApiRepository
- DockerProxyAttributes
- DockerProxyRepositoryApiRequest
- FileBlobStoreApiCreateRequest
- FileBlobStoreApiModel
- FileBlobStoreApiUpdateRequest
- FrequencyXO
- GenericBlobStoreApiResponse
- GitLfsHostedRepositoryApiRequest
- GolangGroupRepositoryApiRequest
- GolangProxyRepositoryApiRequest
- GoogleCloudBlobStoreApiBucket
- GoogleCloudBlobStoreApiBucketAuthentication
- GoogleCloudBlobStoreApiBucketConfiguration
- GoogleCloudBlobstoreApiModel
- GroupAttributes
- GroupBlobStoreApiCreateRequest
- GroupBlobStoreApiModel
- GroupBlobStoreApiResponse
- GroupBlobStoreApiUpdateRequest
- GroupDeployAttributes
- HelmHostedRepositoryApiRequest
- HelmProxyRepositoryApiRequest
- HostedStorageAttributes
- HttpClientAttributes
- HttpClientAttributesWithPreemptiveAuth
- HttpClientConnectionAttributes
- HttpClientConnectionAuthenticationAttributes
- HttpClientConnectionAuthenticationAttributesWithPreemptive
- HttpSettingsXo
- IqAuditXo
- IqConnectionVerificationXo
- IqConnectionXo
- MaliciousRiskOnDiskCountResponse
- MavenAttributes
- MavenGroupRepositoryApiRequest
- MavenHostedApiRepository
- MavenHostedRepositoryApiRequest
- MavenProxyApiRepository
- MavenProxyRepositoryApiRequest
- NegativeCacheAttributes
- NodeInformation
- NpmAttributes
- NpmGroupRepositoryApiRequest
- NpmHostedRepositoryApiRequest
- NpmProxyApiRepository
- NpmProxyRepositoryApiRequest
- NugetAttributes
- NugetGroupRepositoryApiRequest
- NugetHostedRepositoryApiRequest
- NugetProxyApiRepository
- NugetProxyRepositoryApiRequest
- P2ProxyRepositoryApiRequest
- Page
- PageAssetXO
- PageComponentXO
- PageTagXO
- PageTaskXO
- ProxyAttributes
- ProxySettingsXo
- PyPiProxyAttributes
- PypiGroupRepositoryApiRequest
- PypiHostedRepositoryApiRequest
- PypiProxyRepositoryApiRequest
- RGroupRepositoryApiRequest
- RHostedRepositoryApiRequest
- RProxyRepositoryApiRequest
- RawAttributes
- RawGroupRepositoryApiRequest
- RawHostedRepositoryApiRequest
- RawProxyRepositoryApiRequest
- ReEncryptionRequestApiXO
- ReadLdapServerXo
- ReadOnlyState
- RealmApiXO
- ReplicationAttributes
- RepositoryXO
- Result
- RoleXORequest
- RoleXOResponse
- RoutingRuleXO
- RubyGemsGroupRepositoryApiRequest
- RubyGemsHostedRepositoryApiRequest
- RubyGemsProxyRepositoryApiRequest
- S3BlobStoreApiAdvancedBucketConnection
- S3BlobStoreApiBucket
- S3BlobStoreApiBucketConfiguration
- S3BlobStoreApiBucketSecurity
- S3BlobStoreApiEncryption
- S3BlobStoreApiFailoverBucket
- S3BlobStoreApiModel
- SamlConfigurationXO
- ScriptResultXO
- ScriptXO
- SimpleApiGroupDeployRepository
- SimpleApiGroupRepository
- SimpleApiHostedRepository
- SimpleApiProxyRepository
- StackTraceElement
- StorageAttributes
- SupportZipGeneratorRequest
- SupportZipXO
- SystemCheckResultDTO
- SystemCheckResultsApiDTO
- TagXO
- TaskTemplateXO
- TaskXO
- Throwable
- UpdateLdapServerXo
- UploadComponentRequest
- UploadDefinitionXO
- UploadFieldDefinitionXO
- UserTokensApiModel
- YumAttributes
- YumGroupRepositoryApiRequest
- YumHostedApiRepository
- YumHostedRepositoryApiRequest
- YumProxyRepositoryApiRequest
- YumSigningRepositoriesAttributes
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