Skip to main content

Sonatype Nexus Repository Manager

Project description

nexus-api-client

This documents the available APIs into Sonatype Nexus Repository Manager as of version 3.92.0-03.

This Python package is automatically generated by the OpenAPI Generator project:

  • API version: 3.92.0-03
  • Package version: 1.0.0
  • Generator version: 7.16.0
  • Build package: org.openapitools.codegen.languages.PythonClientCodegen For more information, please visit https://github.com/sonatype-nexus-community

Requirements.

Python 3.9+

Installation & Usage

pip install

If the python package is hosted on a repository, you can install directly using:

pip install git+https://github.com/sonatype-nexus-community/nexus-repo-api-client.git

(you may need to run pip with root permission: sudo pip install git+https://github.com/sonatype-nexus-community/nexus-repo-api-client.git)

Then import the package:

import nexus_api_client

Setuptools

Install via Setuptools.

python setup.py install --user

(or sudo python setup.py install to install the package for all users)

Then import the package:

import nexus_api_client

Tests

Execute pytest to run the tests.

Getting Started

Please follow the installation procedure and then run the following:

import nexus_api_client
from nexus_api_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost/service/rest
# See configuration.py for a list of all supported configuration parameters.
configuration = nexus_api_client.Configuration(
    host = "http://localhost/service/rest"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure HTTP basic authorization: BasicAuth
configuration = nexus_api_client.Configuration(
    username = os.environ["USERNAME"],
    password = os.environ["PASSWORD"]
)


# Enter a context with an instance of the API client
with nexus_api_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = nexus_api_client.AzureBlobStoreApi(api_client)
    body = nexus_api_client.AzureConnectionXO() # AzureConnectionXO |  (optional)

    try:
        # Verify connection using supplied Azure Blob Store settings
        api_instance.verify_connection2(body=body)
    except ApiException as e:
        print("Exception when calling AzureBlobStoreApi->verify_connection2: %s\n" % e)

Documentation for API Endpoints

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

Class Method HTTP request Description
AzureBlobStoreApi verify_connection2 POST /v1/azureblobstore/test-connection Verify connection using supplied Azure Blob Store settings
BlobStoreApi convert_blob_store_to_group POST /v1/blobstores/group/convert/{name}/{newNameForOriginal} Convert a blob store to a group blob store
BlobStoreApi create_blob_store1 POST /v1/blobstores/azure Create an Azure blob store
BlobStoreApi create_blob_store2 POST /v1/blobstores/google Create a Google Cloud blob store
BlobStoreApi create_file_blob_store POST /v1/blobstores/file Create a file blob store
BlobStoreApi create_group_blob_store POST /v1/blobstores/group Create a group blob store
BlobStoreApi create_s3_blob_store POST /v1/blobstores/s3 Create an S3 blob store
BlobStoreApi delete_blob_store DELETE /v1/blobstores/{name} Delete a blob store by name
BlobStoreApi get_blob_store1 GET /v1/blobstores/azure/{name} Get an Azure blob store configuration by name
BlobStoreApi get_blob_store2 GET /v1/blobstores/google/{name} Get the configuration for a Google Cloud blob store
BlobStoreApi get_file_blob_store_configuration GET /v1/blobstores/file/{name} Get a file blob store configuration by name
BlobStoreApi get_group_blob_store_configuration GET /v1/blobstores/group/{name} Get a group blob store configuration by name
BlobStoreApi get_regions_by_project_id GET /v1/blobstores/google/regions/{projectId} Get the project regions by project's id
BlobStoreApi get_s3_blob_store GET /v1/blobstores/s3/{name} Get a S3 blob store configuration by name
BlobStoreApi list_blob_stores GET /v1/blobstores List the blob stores
BlobStoreApi quota_status GET /v1/blobstores/{name}/quota-status Get quota status for a given blob store
BlobStoreApi update_blob_store1 PUT /v1/blobstores/azure/{name} Update an Azure blob store configuration by name
BlobStoreApi update_blob_store2 PUT /v1/blobstores/google/{name} Update a Google Cloud blob store
BlobStoreApi update_file_blob_store PUT /v1/blobstores/file/{name} Update a file blob store configuration by name
BlobStoreApi update_group_blob_store PUT /v1/blobstores/group/{name} Update a group blob store configuration by name
BlobStoreApi update_s3_blob_store PUT /v1/blobstores/s3/{name} Update an S3 blob store configuration by name
CapabilitiesApi create4 POST /v1/capabilities Create a capability
CapabilitiesApi delete5 DELETE /v1/capabilities/{capabilityId} Delete a capability
CapabilitiesApi get_types GET /v1/capabilities/types List all capability types available and exposed in the system
CapabilitiesApi list2 GET /v1/capabilities List the active capabilities
CapabilitiesApi update3 PUT /v1/capabilities/{capabilityId} Update a capability
CleanupPoliciesApi create1 POST /v1/cleanup-policies Create a new policy
CleanupPoliciesApi delete_policy_by_name DELETE /v1/cleanup-policies/{name} Delete cleanup policy
CleanupPoliciesApi get_all GET /v1/cleanup-policies Get a list of existing policies
CleanupPoliciesApi get_cleanup_policy_by_name GET /v1/cleanup-policies/{name} Get a policy by name
CleanupPoliciesApi update2 PUT /v1/cleanup-policies/{policyName} Update existing policy
CommunityEditionEulaApi get_community_eula_status GET /v1/system/eula Get the current Community Eula status.
CommunityEditionEulaApi set_eula_accepted_ce POST /v1/system/eula Set the Community Eula status.
ContentSelectorsApi create_content_selector POST /v1/security/content-selectors Create a new content selector
ContentSelectorsApi delete_content_selector DELETE /v1/security/content-selectors/{name} Delete a content selector
ContentSelectorsApi get_content_selector GET /v1/security/content-selectors/{name} Get a content selector by name
ContentSelectorsApi get_content_selectors GET /v1/security/content-selectors List content selectors
ContentSelectorsApi update_content_selector PUT /v1/security/content-selectors/{name} Update a content selector
DataStoreApi get_data_store GET /beta/data-store Get the data store
DataStoreApi update_data_store PUT /beta/data-store Update the data store
EmailApi delete_email_configuration DELETE /v1/email Disable and clear the email configuration
EmailApi get_email_configuration GET /v1/email Retrieve the current email configuration
EmailApi set_email_configuration PUT /v1/email Set the current email configuration
EmailApi test_email_configuration POST /v1/email/verify Send a test email to the email address provided in the request body
FormatsApi get GET /v1/formats/{format}/upload-specs Get upload field requirements for the desired format
FormatsApi get1 GET /v1/formats/upload-specs Get upload field requirements for each supported format
InstanceConfigurationApi apply_configuration PUT /v1/configuration Apply instance configuration
InstanceConfigurationApi clear_cipher_password DELETE /v1/configuration/cipher Clear migration cipher password
InstanceConfigurationApi export_configuration GET /v1/configuration Export instance configuration
InstanceConfigurationApi get_assets1 GET /v1/configuration/assets List assets
InstanceConfigurationApi import_asset POST /v1/configuration/assets/{repositoryName}/import Import assets to repository
InstanceConfigurationApi set_cipher_password POST /v1/configuration/cipher Set migration cipher password for decrypting imported secrets
InstanceConfigurationApi transfer_complete POST /v1/configuration/transfer-complete Receive transfer complete notification from migrator
InternalUIAPIPermissionsApi list GET /internal/ui/api/permissions List REST endpoints with permission metadata for the API documentation UI
LifecycleApi bounce PUT /v1/lifecycle/bounce Bounce lifecycle phase
LifecycleApi get_phase GET /v1/lifecycle/phase Get current lifecycle phase
LifecycleApi set_phase PUT /v1/lifecycle/phase Move to new lifecycle phase
MaliciousRiskOnDiskApi acknowledge_finding POST /v1/malicious-risk/acknowledge/{id}
MaliciousRiskOnDiskApi delete_finding POST /v1/malicious-risk/delete-finding/{id}
MaliciousRiskOnDiskApi get_active_findings GET /v1/malicious-risk/active-findings
MaliciousRiskOnDiskApi get_enabled_registries GET /v1/malicious-risk/enabledRegistries Get RHC Enabled registries for malicious risk scanning.
MaliciousRiskOnDiskApi get_history GET /v1/malicious-risk/history
MaliciousRiskOnDiskApi get_malicious_risk_components GET /v1/malicious-risk/components List malicious components with asset IDs for removal
MaliciousRiskOnDiskApi get_malicious_risk_on_disk_count GET /v1/malicious-risk/risk-on-disk Get Malicious Risk On Disk Count
MaliciousRiskOnDiskApi remediate_findings POST /v1/malicious-risk/remediate
ManageSonatypeHTTPSystemSettingsApi get_http_settings GET /v1/http Get HTTP system settings
ManageSonatypeHTTPSystemSettingsApi reset_http_settings DELETE /v1/http Reset HTTP System Settings
ManageSonatypeHTTPSystemSettingsApi update_http_settings PUT /v1/http Update HTTP system settings
ManageSonatypeRepositoryFirewallConfigurationApi disable_iq POST /v1/iq/disable Disable Sonatype Repository Firewall
ManageSonatypeRepositoryFirewallConfigurationApi enable_iq POST /v1/iq/enable Enable Sonatype Repository Firewall
ManageSonatypeRepositoryFirewallConfigurationApi get_all_audit_status GET /v1/iq/audit List repositories audit statuses.
ManageSonatypeRepositoryFirewallConfigurationApi get_audit_status GET /v1/iq/audit/{repositoryName} Get audit status for the repository
ManageSonatypeRepositoryFirewallConfigurationApi get_capabilities POST /v1/iq/capabilities/test Get IQ Server capabilities for a specific configuration
ManageSonatypeRepositoryFirewallConfigurationApi get_capabilities1 GET /v1/iq/capabilities Get IQ Server capabilities (Firewall and Lifecycle)
ManageSonatypeRepositoryFirewallConfigurationApi get_configuration1 GET /v1/iq Get Sonatype Repository Firewall configuration
ManageSonatypeRepositoryFirewallConfigurationApi manage_audit PUT /v1/iq/audit Manage audit
ManageSonatypeRepositoryFirewallConfigurationApi test_new_connection POST /v1/iq/test-new-connection Test new Sonatype Repository Firewall connection
ManageSonatypeRepositoryFirewallConfigurationApi update_configuration1 PUT /v1/iq Update Sonatype Repository Firewall configuration
ManageSonatypeRepositoryFirewallConfigurationApi verify_iq_connection POST /v1/iq/verify-connection Verify Sonatype Repository Firewall connection
MonthlyMetricsApi get_last12_months_metrics GET /v1/monthly-metrics Get the last 12 months of metrics.
ProductLicensingApi get_license_status GET /v1/system/license Get the current license status.
ProductLicensingApi remove_license DELETE /v1/system/license Uninstall license if present.
ProductLicensingApi set_license POST /v1/system/license Upload a new license file.
ReconcilePlanApi create_reconciliation_plans POST /v1/plan Create reconciliation plans with selected parameters
ReconcilePlanApi delete_all_plans DELETE /v1/plan Delete all non executed reconciliation plans
ReconcilePlanApi delete_plan DELETE /v1/plan/{planId} Delete a reconciliation plan based on its Id
ReconcilePlanApi execute_reconcile_task_by_id PUT /v1/plan/{planId} Execute a reconciliation plan based on its Id
ReconcilePlanApi execute_reconcile_tasks PUT /v1/plan Execute all non executed reconciliation plans
ReconcilePlanApi get_available_plans GET /v1/plan Get list of currently available plans
ReconcilePlanApi get_plan_details GET /v1/plan/details Get reconciliation plan details
ReconcilePlanApi get_single_plan_with_details GET /v1/plan/{planId} Get single reconciliation plan with details
RecoveryModeApi disable_recovery_mode DELETE /v1/recovery-mode Disables recovery mode
RecoveryModeApi enable_recovery_mode POST /v1/recovery-mode Enables recovery mode and cancels conflicting tasks if running
RepositoryBrowseApi delete_folder DELETE /v1/repositories/{repositoryName}/browse Delete a folder and all its contents
RepositoryBrowseApi getrepositoryname_browse_repository GET /v1/repositories/{repositoryName}/browse List browse nodes for a repository path
RepositoryManagementApi create_apt_hosted_repository POST /v1/repositories/apt/hosted Create APT hosted repository
RepositoryManagementApi create_apt_proxy_repository POST /v1/repositories/apt/proxy Create APT proxy repository
RepositoryManagementApi create_cargo_group_repository POST /v1/repositories/cargo/group Create cargo group repository
RepositoryManagementApi create_cargo_hosted_repository POST /v1/repositories/cargo/hosted Create cargo hosted repository
RepositoryManagementApi create_cargo_proxy_repository POST /v1/repositories/cargo/proxy Create cargo proxy repository
RepositoryManagementApi create_cocoapods_proxy_repository POST /v1/repositories/cocoapods/proxy Create Cocoapods proxy repository
RepositoryManagementApi create_composer_proxy_repository POST /v1/repositories/composer/proxy Create composer proxy repository
RepositoryManagementApi create_conan_group_repository POST /v1/repositories/conan/group Create Conan group repository
RepositoryManagementApi create_conan_hosted_repository POST /v1/repositories/conan/hosted Create Conan hosted repository
RepositoryManagementApi create_conan_proxy_repository POST /v1/repositories/conan/proxy Create Conan proxy repository
RepositoryManagementApi create_conda_group_repository POST /v1/repositories/conda/group Create Conda group repository
RepositoryManagementApi create_conda_hosted_repository POST /v1/repositories/conda/hosted Create conda hosted repository
RepositoryManagementApi create_conda_proxy_repository POST /v1/repositories/conda/proxy Create conda proxy repository
RepositoryManagementApi create_docker_group_repository POST /v1/repositories/docker/group Create Docker group repository
RepositoryManagementApi create_docker_hosted_repository POST /v1/repositories/docker/hosted Create Docker hosted repository
RepositoryManagementApi create_docker_proxy_repository POST /v1/repositories/docker/proxy Create Docker proxy repository
RepositoryManagementApi create_gitlfs_hosted_repository POST /v1/repositories/gitlfs/hosted Create Git LFS hosted repository
RepositoryManagementApi create_go_group_repository POST /v1/repositories/go/group Create a Go group repository
RepositoryManagementApi create_go_proxy_repository POST /v1/repositories/go/proxy Create a Go proxy repository
RepositoryManagementApi create_helm_group_repository POST /v1/repositories/helm/group Create Helm group repository
RepositoryManagementApi create_helm_hosted_repository POST /v1/repositories/helm/hosted Create Helm hosted repository
RepositoryManagementApi create_helm_proxy_repository POST /v1/repositories/helm/proxy Create Helm proxy repository
RepositoryManagementApi create_huggingface_proxy_repository POST /v1/repositories/huggingface/proxy Create huggingface proxy repository
RepositoryManagementApi create_maven_group_repository POST /v1/repositories/maven/group Create Maven group repository
RepositoryManagementApi create_maven_hosted_repository POST /v1/repositories/maven/hosted Create Maven hosted repository
RepositoryManagementApi create_maven_proxy_repository POST /v1/repositories/maven/proxy Create Maven proxy repository
RepositoryManagementApi create_npm_group_repository POST /v1/repositories/npm/group Create npm group repository
RepositoryManagementApi create_npm_hosted_repository POST /v1/repositories/npm/hosted Create npm hosted repository
RepositoryManagementApi create_npm_proxy_repository POST /v1/repositories/npm/proxy Create npm proxy repository
RepositoryManagementApi create_nuget_group_repository POST /v1/repositories/nuget/group Create NuGet group repository
RepositoryManagementApi create_nuget_hosted_repository POST /v1/repositories/nuget/hosted Create NuGet hosted repository
RepositoryManagementApi create_nuget_proxy_repository POST /v1/repositories/nuget/proxy Create NuGet proxy repository
RepositoryManagementApi create_p2_proxy_repository POST /v1/repositories/p2/proxy Create p2 proxy repository
RepositoryManagementApi create_pub_group_repository POST /v1/repositories/pub/group Create Pub group repository
RepositoryManagementApi create_pub_hosted_repository POST /v1/repositories/pub/hosted Create Pub hosted repository
RepositoryManagementApi create_pub_proxy_repository POST /v1/repositories/pub/proxy Create Pub proxy repository
RepositoryManagementApi create_pypi_group_repository POST /v1/repositories/pypi/group Create PyPI group repository
RepositoryManagementApi create_pypi_hosted_repository POST /v1/repositories/pypi/hosted Create PyPI hosted repository
RepositoryManagementApi create_pypi_proxy_repository POST /v1/repositories/pypi/proxy Create PyPI proxy repository
RepositoryManagementApi create_r_group_repository POST /v1/repositories/r/group Create R group repository
RepositoryManagementApi create_r_hosted_repository POST /v1/repositories/r/hosted Create R hosted repository
RepositoryManagementApi create_r_proxy_repository POST /v1/repositories/r/proxy Create R proxy repository
RepositoryManagementApi create_raw_group_repository POST /v1/repositories/raw/group Create raw group repository
RepositoryManagementApi create_raw_hosted_repository POST /v1/repositories/raw/hosted Create raw hosted repository
RepositoryManagementApi create_raw_proxy_repository POST /v1/repositories/raw/proxy Create raw proxy repository
RepositoryManagementApi create_rubygems_group_repository POST /v1/repositories/rubygems/group Create RubyGems group repository
RepositoryManagementApi create_rubygems_hosted_repository POST /v1/repositories/rubygems/hosted Create RubyGems hosted repository
RepositoryManagementApi create_rubygems_proxy_repository POST /v1/repositories/rubygems/proxy Create RubyGems proxy repository
RepositoryManagementApi create_swift_group_repository POST /v1/repositories/swift/group Create Swift group repository
RepositoryManagementApi create_swift_hosted_repository POST /v1/repositories/swift/hosted Create swift hosted repository
RepositoryManagementApi create_swift_proxy_repository POST /v1/repositories/swift/proxy Create swift proxy repository
RepositoryManagementApi create_terraform_group_repository POST /v1/repositories/terraform/group Create Terraform group repository
RepositoryManagementApi create_terraform_hosted_repository POST /v1/repositories/terraform/hosted Create terraform hosted repository
RepositoryManagementApi create_terraform_proxy_repository POST /v1/repositories/terraform/proxy Create terraform proxy repository
RepositoryManagementApi create_yum_group_repository POST /v1/repositories/yum/group Create Yum group repository
RepositoryManagementApi create_yum_hosted_repository POST /v1/repositories/yum/hosted Create Yum hosted repository
RepositoryManagementApi create_yum_proxy_repository POST /v1/repositories/yum/proxy Create Yum proxy repository
RepositoryManagementApi createrepositoryname_health_check_repository POST /v1/repositories/{repositoryName}/health-check Enable repository health check. Proxy repositories only.
RepositoryManagementApi createrepositoryname_invalidate_cache_repository POST /v1/repositories/{repositoryName}/invalidate-cache Invalidate repository cache. Proxy or group repositories only.
RepositoryManagementApi createrepositoryname_rebuild_index_repository POST /v1/repositories/{repositoryName}/rebuild-index Schedule a 'Repair - Rebuild repository search' Task. Hosted or proxy repositories only.
RepositoryManagementApi delete_repository DELETE /v1/repositories/{repositoryName} Delete repository of any format
RepositoryManagementApi disable_repository_health_check DELETE /v1/repositories/{repositoryName}/health-check Disable repository health check. Proxy repositories only.
RepositoryManagementApi get_all_repositories GET /v1/repositories List repositories
RepositoryManagementApi get_apt_hosted_repository GET /v1/repositories/apt/hosted/{repositoryName} Get repository
RepositoryManagementApi get_apt_proxy_repository GET /v1/repositories/apt/proxy/{repositoryName} Get repository
RepositoryManagementApi get_cargo_group_repository GET /v1/repositories/cargo/group/{repositoryName} Get repository
RepositoryManagementApi get_cargo_hosted_repository GET /v1/repositories/cargo/hosted/{repositoryName} Get repository
RepositoryManagementApi get_cargo_proxy_repository GET /v1/repositories/cargo/proxy/{repositoryName} Get repository
RepositoryManagementApi get_cocoapods_proxy_repository GET /v1/repositories/cocoapods/proxy/{repositoryName} Get repository
RepositoryManagementApi get_composer_proxy_repository GET /v1/repositories/composer/proxy/{repositoryName} Get repository
RepositoryManagementApi get_conan_group_repository GET /v1/repositories/conan/group/{repositoryName} Get repository
RepositoryManagementApi get_conan_hosted_repository GET /v1/repositories/conan/hosted/{repositoryName} Get repository
RepositoryManagementApi get_conan_proxy_repository GET /v1/repositories/conan/proxy/{repositoryName} Get repository
RepositoryManagementApi get_conda_group_repository GET /v1/repositories/conda/group/{repositoryName} Get repository
RepositoryManagementApi get_conda_hosted_repository GET /v1/repositories/conda/hosted/{repositoryName} Get repository
RepositoryManagementApi get_conda_proxy_repository GET /v1/repositories/conda/proxy/{repositoryName} Get repository
RepositoryManagementApi get_docker_group_repository GET /v1/repositories/docker/group/{repositoryName} Get repository
RepositoryManagementApi get_docker_hosted_repository GET /v1/repositories/docker/hosted/{repositoryName} Get repository
RepositoryManagementApi get_docker_proxy_repository GET /v1/repositories/docker/proxy/{repositoryName} Get repository
RepositoryManagementApi get_gitlfs_hosted_repository GET /v1/repositories/gitlfs/hosted/{repositoryName} Get repository
RepositoryManagementApi get_go_group_repository GET /v1/repositories/go/group/{repositoryName} Get repository
RepositoryManagementApi get_go_proxy_repository GET /v1/repositories/go/proxy/{repositoryName} Get repository
RepositoryManagementApi get_helm_group_repository GET /v1/repositories/helm/group/{repositoryName} Get repository
RepositoryManagementApi get_helm_hosted_repository GET /v1/repositories/helm/hosted/{repositoryName} Get repository
RepositoryManagementApi get_helm_proxy_repository GET /v1/repositories/helm/proxy/{repositoryName} Get repository
RepositoryManagementApi get_huggingface_proxy_repository GET /v1/repositories/huggingface/proxy/{repositoryName} Get repository
RepositoryManagementApi get_maven_group_repository GET /v1/repositories/maven/group/{repositoryName} Get repository
RepositoryManagementApi get_maven_hosted_repository GET /v1/repositories/maven/hosted/{repositoryName} Get repository
RepositoryManagementApi get_maven_proxy_repository GET /v1/repositories/maven/proxy/{repositoryName} Get repository
RepositoryManagementApi get_npm_group_repository GET /v1/repositories/npm/group/{repositoryName} Get repository
RepositoryManagementApi get_npm_hosted_repository GET /v1/repositories/npm/hosted/{repositoryName} Get repository
RepositoryManagementApi get_npm_proxy_repository GET /v1/repositories/npm/proxy/{repositoryName} Get repository
RepositoryManagementApi get_nuget_group_repository GET /v1/repositories/nuget/group/{repositoryName} Get repository
RepositoryManagementApi get_nuget_hosted_repository GET /v1/repositories/nuget/hosted/{repositoryName} Get repository
RepositoryManagementApi get_nuget_proxy_repository GET /v1/repositories/nuget/proxy/{repositoryName} Get repository
RepositoryManagementApi get_p2_proxy_repository GET /v1/repositories/p2/proxy/{repositoryName} Get repository
RepositoryManagementApi get_pub_group_repository GET /v1/repositories/pub/group/{repositoryName} Get repository
RepositoryManagementApi get_pub_hosted_repository GET /v1/repositories/pub/hosted/{repositoryName} Get repository
RepositoryManagementApi get_pub_proxy_repository GET /v1/repositories/pub/proxy/{repositoryName} Get repository
RepositoryManagementApi get_pypi_group_repository GET /v1/repositories/pypi/group/{repositoryName} Get repository
RepositoryManagementApi get_pypi_hosted_repository GET /v1/repositories/pypi/hosted/{repositoryName} Get repository
RepositoryManagementApi get_pypi_proxy_repository GET /v1/repositories/pypi/proxy/{repositoryName} Get repository
RepositoryManagementApi get_r_group_repository GET /v1/repositories/r/group/{repositoryName} Get repository
RepositoryManagementApi get_r_hosted_repository GET /v1/repositories/r/hosted/{repositoryName} Get repository
RepositoryManagementApi get_r_proxy_repository GET /v1/repositories/r/proxy/{repositoryName} Get repository
RepositoryManagementApi get_raw_group_repository GET /v1/repositories/raw/group/{repositoryName} Get repository
RepositoryManagementApi get_raw_hosted_repository GET /v1/repositories/raw/hosted/{repositoryName} Get repository
RepositoryManagementApi get_raw_proxy_repository GET /v1/repositories/raw/proxy/{repositoryName} Get repository
RepositoryManagementApi get_repositories GET /v1/repositorySettings List repositories
RepositoryManagementApi get_repository GET /v1/repositories/{repositoryName} Get repository details
RepositoryManagementApi get_rubygems_group_repository GET /v1/repositories/rubygems/group/{repositoryName} Get repository
RepositoryManagementApi get_rubygems_hosted_repository GET /v1/repositories/rubygems/hosted/{repositoryName} Get repository
RepositoryManagementApi get_rubygems_proxy_repository GET /v1/repositories/rubygems/proxy/{repositoryName} Get repository
RepositoryManagementApi get_swift_group_repository GET /v1/repositories/swift/group/{repositoryName} Get repository
RepositoryManagementApi get_swift_hosted_repository GET /v1/repositories/swift/hosted/{repositoryName} Get repository
RepositoryManagementApi get_swift_proxy_repository GET /v1/repositories/swift/proxy/{repositoryName} Get repository
RepositoryManagementApi get_terraform_group_repository GET /v1/repositories/terraform/group/{repositoryName} Get repository
RepositoryManagementApi get_terraform_hosted_repository GET /v1/repositories/terraform/hosted/{repositoryName} Get repository
RepositoryManagementApi get_terraform_proxy_repository GET /v1/repositories/terraform/proxy/{repositoryName} Get repository
RepositoryManagementApi get_yum_group_repository GET /v1/repositories/yum/group/{repositoryName} Get repository
RepositoryManagementApi get_yum_hosted_repository GET /v1/repositories/yum/hosted/{repositoryName} Get repository
RepositoryManagementApi get_yum_proxy_repository GET /v1/repositories/yum/proxy/{repositoryName} Get repository
RepositoryManagementApi update_apt_hosted_repository PUT /v1/repositories/apt/hosted/{repositoryName} Update APT hosted repository
RepositoryManagementApi update_apt_proxy_repository PUT /v1/repositories/apt/proxy/{repositoryName} Update APT proxy repository
RepositoryManagementApi update_cargo_group_repository PUT /v1/repositories/cargo/group/{repositoryName} Update cargo group repository
RepositoryManagementApi update_cargo_hosted_repository PUT /v1/repositories/cargo/hosted/{repositoryName} Update cargo hosted repository
RepositoryManagementApi update_cargo_proxy_repository PUT /v1/repositories/cargo/proxy/{repositoryName} Update cargo proxy repository
RepositoryManagementApi update_cocoapods_proxy_repository PUT /v1/repositories/cocoapods/proxy/{repositoryName} Update Cocoapods proxy repository
RepositoryManagementApi update_composer_proxy_repository PUT /v1/repositories/composer/proxy/{repositoryName} Update composer proxy repository
RepositoryManagementApi update_conan_group_repository PUT /v1/repositories/conan/group/{repositoryName} Update Conan group repository
RepositoryManagementApi update_conan_hosted_repository PUT /v1/repositories/conan/hosted/{repositoryName} Update Conan hosted repository
RepositoryManagementApi update_conan_proxy_repository PUT /v1/repositories/conan/proxy/{repositoryName} Update Conan proxy repository
RepositoryManagementApi update_conda_group_repository PUT /v1/repositories/conda/group/{repositoryName} Update Conda group repository
RepositoryManagementApi update_conda_hosted_repository PUT /v1/repositories/conda/hosted/{repositoryName} Update conda hosted repository
RepositoryManagementApi update_conda_proxy_repository PUT /v1/repositories/conda/proxy/{repositoryName} Update conda proxy repository
RepositoryManagementApi update_docker_group_repository PUT /v1/repositories/docker/group/{repositoryName} Update Docker group repository
RepositoryManagementApi update_docker_hosted_repository PUT /v1/repositories/docker/hosted/{repositoryName} Update Docker hosted repository
RepositoryManagementApi update_docker_proxy_repository PUT /v1/repositories/docker/proxy/{repositoryName} Update Docker proxy repository
RepositoryManagementApi update_gitlfs_hosted_repository PUT /v1/repositories/gitlfs/hosted/{repositoryName} Update Git LFS hosted repository
RepositoryManagementApi update_go_group_repository PUT /v1/repositories/go/group/{repositoryName} Update a Go group repository
RepositoryManagementApi update_go_proxy_repository PUT /v1/repositories/go/proxy/{repositoryName} Update a Go proxy repository
RepositoryManagementApi update_helm_group_repository PUT /v1/repositories/helm/group/{repositoryName} Update Helm group repository
RepositoryManagementApi update_helm_hosted_repository PUT /v1/repositories/helm/hosted/{repositoryName} Update Helm hosted repository
RepositoryManagementApi update_helm_proxy_repository PUT /v1/repositories/helm/proxy/{repositoryName} Update Helm proxy repository
RepositoryManagementApi update_huggingface_proxy_repository PUT /v1/repositories/huggingface/proxy/{repositoryName} Update huggingface proxy repository
RepositoryManagementApi update_maven_group_repository PUT /v1/repositories/maven/group/{repositoryName} Update Maven group repository
RepositoryManagementApi update_maven_hosted_repository PUT /v1/repositories/maven/hosted/{repositoryName} Update Maven hosted repository
RepositoryManagementApi update_maven_proxy_repository PUT /v1/repositories/maven/proxy/{repositoryName} Update Maven proxy repository
RepositoryManagementApi update_npm_group_repository PUT /v1/repositories/npm/group/{repositoryName} Update npm group repository
RepositoryManagementApi update_npm_hosted_repository PUT /v1/repositories/npm/hosted/{repositoryName} Update npm hosted repository
RepositoryManagementApi update_npm_proxy_repository PUT /v1/repositories/npm/proxy/{repositoryName} Update npm proxy repository
RepositoryManagementApi update_nuget_group_repository PUT /v1/repositories/nuget/group/{repositoryName} Update NuGet group repository
RepositoryManagementApi update_nuget_hosted_repository PUT /v1/repositories/nuget/hosted/{repositoryName} Update NuGet hosted repository
RepositoryManagementApi update_nuget_proxy_repository PUT /v1/repositories/nuget/proxy/{repositoryName} Update NuGet proxy repository
RepositoryManagementApi update_p2_proxy_repository PUT /v1/repositories/p2/proxy/{repositoryName} Update p2 proxy repository
RepositoryManagementApi update_pub_group_repository PUT /v1/repositories/pub/group/{repositoryName} Update Pub group repository
RepositoryManagementApi update_pub_hosted_repository PUT /v1/repositories/pub/hosted/{repositoryName} Update Pub hosted repository
RepositoryManagementApi update_pub_proxy_repository PUT /v1/repositories/pub/proxy/{repositoryName} Update Pub proxy repository
RepositoryManagementApi update_pypi_group_repository PUT /v1/repositories/pypi/group/{repositoryName} Update PyPI group repository
RepositoryManagementApi update_pypi_hosted_repository PUT /v1/repositories/pypi/hosted/{repositoryName} Update PyPI hosted repository
RepositoryManagementApi update_pypi_proxy_repository PUT /v1/repositories/pypi/proxy/{repositoryName} Update PyPI proxy repository
RepositoryManagementApi update_r_group_repository PUT /v1/repositories/r/group/{repositoryName} Update R group repository
RepositoryManagementApi update_r_hosted_repository PUT /v1/repositories/r/hosted/{repositoryName} Update R hosted repository
RepositoryManagementApi update_r_proxy_repository PUT /v1/repositories/r/proxy/{repositoryName} Update R proxy repository
RepositoryManagementApi update_raw_group_repository PUT /v1/repositories/raw/group/{repositoryName} Update raw group repository
RepositoryManagementApi update_raw_hosted_repository PUT /v1/repositories/raw/hosted/{repositoryName} Update raw hosted repository
RepositoryManagementApi update_raw_proxy_repository PUT /v1/repositories/raw/proxy/{repositoryName} Update raw proxy repository
RepositoryManagementApi update_rubygems_group_repository PUT /v1/repositories/rubygems/group/{repositoryName} Update RubyGems group repository
RepositoryManagementApi update_rubygems_hosted_repository PUT /v1/repositories/rubygems/hosted/{repositoryName} Update RubyGems hosted repository
RepositoryManagementApi update_rubygems_proxy_repository PUT /v1/repositories/rubygems/proxy/{repositoryName} Update RubyGems proxy repository
RepositoryManagementApi update_swift_group_repository PUT /v1/repositories/swift/group/{repositoryName} Update Swift group repository
RepositoryManagementApi update_swift_hosted_repository PUT /v1/repositories/swift/hosted/{repositoryName} Update swift hosted repository
RepositoryManagementApi update_swift_proxy_repository PUT /v1/repositories/swift/proxy/{repositoryName} Update swift proxy repository
RepositoryManagementApi update_terraform_group_repository PUT /v1/repositories/terraform/group/{repositoryName} Update Terraform group repository
RepositoryManagementApi update_terraform_hosted_repository PUT /v1/repositories/terraform/hosted/{repositoryName} Update terraform hosted repository
RepositoryManagementApi update_terraform_proxy_repository PUT /v1/repositories/terraform/proxy/{repositoryName} Update terraform proxy repository
RepositoryManagementApi update_yum_group_repository PUT /v1/repositories/yum/group/{repositoryName} Update Yum group repository
RepositoryManagementApi update_yum_hosted_repository PUT /v1/repositories/yum/hosted/{repositoryName} Update Yum hosted repository
RepositoryManagementApi update_yum_proxy_repository PUT /v1/repositories/yum/proxy/{repositoryName} Update Yum proxy repository
RoutingRulesApi create_routing_rule POST /v1/routing-rules Create a single routing rule
RoutingRulesApi delete_routing_rule DELETE /v1/routing-rules/{name} Delete a single routing rule
RoutingRulesApi get_routing_rule GET /v1/routing-rules/{name} Get a single routing rule
RoutingRulesApi get_routing_rules GET /v1/routing-rules List routing rules
RoutingRulesApi update_routing_rule 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 read 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 search_and_download_assets GET /v1/search/assets/download Search and download asset
SearchApi search_assets GET /v1/search/assets Search assets
SearchApi suggest GET /v1/search/suggest Get search suggestions for autocomplete
SecurityManagementAnonymousAccessApi read1 GET /v1/security/anonymous Get Anonymous Access settings
SecurityManagementAnonymousAccessApi update1 PUT /v1/security/anonymous Update Anonymous Access settings
SecurityManagementSSRFProtectionApi get_configuration GET /v1/security/ssrf-protection Get SSRF protection settings
SecurityManagementSSRFProtectionApi update_configuration PUT /v1/security/ssrf-protection Update SSRF protection settings
SecurityAtlassianCrowdApi clear_cache POST /v1/security/atlassian-crowd/clear-cache Clear Atlassian Crowd cache
SecurityAtlassianCrowdApi read_settings GET /v1/security/atlassian-crowd Retrieve Atlassian Crowd settings configured in Nexus Repository Manager
SecurityAtlassianCrowdApi update_settings PUT /v1/security/atlassian-crowd Update Atlassian Crowd settings configured in Nexus Repository Manager
SecurityAtlassianCrowdApi verify_connection POST /v1/security/atlassian-crowd/verify-connection Verify connection using supplied Atlassian Crowd settings
SecurityCertificatesApi add_certificate POST /v1/security/ssl/truststore Add a certificate to the trust store.
SecurityCertificatesApi get_trust_store_certificates GET /v1/security/ssl/truststore Retrieve a list of certificates added to the trust store.
SecurityCertificatesApi remove_certificate DELETE /v1/security/ssl/truststore/{id} Remove a certificate in the trust store.
SecurityCertificatesApi retrieve_certificate GET /v1/security/ssl Helper method to retrieve certificate details from a remote system.
SecurityManagementApi get_user_sources GET /v1/security/user-sources Retrieve a list of the available user sources.
SecurityManagementAPIAccessApi check_access POST /internal/ui/security/access-check Check if a user or role has access to an API endpoint
SecurityManagementLDAPApi change_order POST /v1/security/ldap/change-order Change LDAP server order
SecurityManagementLDAPApi clear_cache1 DELETE /v1/security/ldap/cache
SecurityManagementLDAPApi create_ldap_server POST /v1/security/ldap Create LDAP server
SecurityManagementLDAPApi delete_ldap_server DELETE /v1/security/ldap/{name} Delete LDAP server
SecurityManagementLDAPApi get_ldap_server GET /v1/security/ldap/{name} Get LDAP server
SecurityManagementLDAPApi get_ldap_servers GET /v1/security/ldap List LDAP servers
SecurityManagementLDAPApi get_templates GET /v1/security/ldap/templates
SecurityManagementLDAPApi update_ldap_server PUT /v1/security/ldap/{name} Update LDAP server
SecurityManagementLDAPApi verify_connection1 POST /v1/security/ldap/verify-connection
SecurityManagementLDAPApi verify_login POST /v1/security/ldap/verify-login
SecurityManagementLDAPApi verify_user_mapping POST /v1/security/ldap/verify-user-mapping
SecurityManagementSAMLApi delete_saml_configuration DELETE /v1/security/saml Delete SAML configuration
SecurityManagementSAMLApi get_metadata GET /v1/security/saml/metadata Get service provider metadata XML document
SecurityManagementSAMLApi get_public_certificate_in_pem_format GET /v1/security/saml/pem Get service provider signing or decryption certificate in PEM format
SecurityManagementSAMLApi get_saml_configuration GET /v1/security/saml Get SAML configuration
SecurityManagementSAMLApi put_saml_configuration PUT /v1/security/saml Create or update SAML configuration
SecurityManagementSAMLUsersApi create_user1 POST /v1/security/saml/users Create a new SAML user. This allows administrators to pre-create SAML users with roles before their first login.
SecurityManagementSAMLUsersApi delete_user1 DELETE /v1/security/saml/users/{userId} Delete a SAML user.
SecurityManagementSAMLUsersApi get_user GET /v1/security/saml/users/{userId} Retrieve a SAML user by userId.
SecurityManagementSAMLUsersApi get_users1 GET /v1/security/saml/users Retrieve a list of SAML users. The response is limited to 1,000 users.
SecurityManagementSAMLUsersApi update_user1 PUT /v1/security/saml/users/{userId} Update a SAML user's roles and attributes.
SecurityManagementApiKeysPrincipalsEncryptionApi re_encrypt PUT /v1/apikeys/encryption/re-encrypt Re-encrypt api keys principals using the specified configuration
SecurityManagementPrivilegesApi create_application_privilege POST /v1/security/privileges/application Create an application type privilege.
SecurityManagementPrivilegesApi create_repository_admin_privilege POST /v1/security/privileges/repository-admin Create a repository admin type privilege.
SecurityManagementPrivilegesApi create_repository_content_selector_privilege POST /v1/security/privileges/repository-content-selector Create a repository content selector type privilege.
SecurityManagementPrivilegesApi create_repository_view_privilege POST /v1/security/privileges/repository-view Create a repository view type privilege.
SecurityManagementPrivilegesApi create_script_privilege POST /v1/security/privileges/script Create a script type privilege.
SecurityManagementPrivilegesApi create_wildcard_privilege POST /v1/security/privileges/wildcard Create a wildcard type privilege.
SecurityManagementPrivilegesApi delete_privilege DELETE /v1/security/privileges/{privilegeName} Delete a privilege by name.
SecurityManagementPrivilegesApi get_all_privileges GET /v1/security/privileges Retrieve a list of privileges.
SecurityManagementPrivilegesApi get_privilege GET /v1/security/privileges/{privilegeName} Retrieve a privilege by name.
SecurityManagementPrivilegesApi update_application_privilege PUT /v1/security/privileges/application/{privilegeName} Update an application type privilege.
SecurityManagementPrivilegesApi update_repository_admin_privilege PUT /v1/security/privileges/repository-admin/{privilegeName} Update a repository admin type privilege.
SecurityManagementPrivilegesApi update_repository_content_selector_privilege PUT /v1/security/privileges/repository-content-selector/{privilegeName} Update a repository content selector type privilege.
SecurityManagementPrivilegesApi update_repository_view_privilege PUT /v1/security/privileges/repository-view/{privilegeName} Update a repository view type privilege.
SecurityManagementPrivilegesApi update_script_privilege PUT /v1/security/privileges/script/{privilegeName} Update a script type privilege.
SecurityManagementPrivilegesApi update_wildcard_privilege PUT /v1/security/privileges/wildcard/{privilegeName} Update a wildcard type privilege.
SecurityManagementRealmsApi get_active_realms GET /v1/security/realms/active List the active realm IDs in order
SecurityManagementRealmsApi get_realms GET /v1/security/realms/available List the available realms
SecurityManagementRealmsApi set_active_realms 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 get_role GET /v1/security/roles/{id} Get role
SecurityManagementRolesApi get_roles GET /v1/security/roles List roles
SecurityManagementRolesApi update PUT /v1/security/roles/{id} Update role
SecurityManagementSecretsEncryptionApi re_encrypt1 PUT /v1/secrets/encryption/re-encrypt Re-encrypt secrets using the specified key
SecurityManagementUserTokensApi list1 GET /v1/security/user-tokens/tokens List all user tokens
SecurityManagementUserTokensApi reset_all_user_tokens DELETE /v1/security/user-tokens
SecurityManagementUserTokensApi service_status GET /v1/security/user-tokens Show if the user token capability is enabled or not
SecurityManagementUserTokensApi set_service_status PUT /v1/security/user-tokens
SecurityManagementUsersApi change_password PUT /v1/security/users/{userId}/change-password Change a user's password.
SecurityManagementUsersApi create3 POST /v1/security/users/{userId}/{realm}/user-token Create a user token for the given user.
SecurityManagementUsersApi create_user POST /v1/security/users Create a new user in the default source.
SecurityManagementUsersApi delete4 DELETE /v1/security/users/{userId}/{realm}/user-token Delete the user token for the given user.
SecurityManagementUsersApi delete_user DELETE /v1/security/users/{userId} Delete a user.
SecurityManagementUsersApi get3 GET /v1/security/users/{userId}/{realm}/user-token Get user token metadata for the given user.
SecurityManagementUsersApi get_users GET /v1/security/users Retrieve a list of users. For SAML user sources a limit of 1000 users will be applied.
SecurityManagementUsersApi reset DELETE /v1/security/users/{userId}/{realm}/user-token-reset Reset the user token for the given user.
SecurityManagementUsersApi update_user PUT /v1/security/users/{userId} Update an existing user.
StagingApi delete2 POST /v1/staging/delete Delete components
StagingApi move POST /v1/staging/move/{destination} Move components
StatusApi get_cluster_system_status_checks GET /beta/status/check/cluster Health check endpoint that returns the results of the system status checks
StatusApi get_node_system_status_checks GET /beta/status/check/{nodeId} Health check endpoint that returns the results of the system status checks of specified Node
StatusApi get_system_status_checks GET /v1/status/check Health check endpoint that returns the results of the system status checks
StatusApi is_available GET /v1/status Health check endpoint that validates server can respond to read requests
StatusApi is_writable 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 get_node_id GET /v1/system/node Get information about this node
SystemNodesApi get_system_information GET /beta/system/information Get information about all nodes
TagsApi associate POST /v1/tags/associate/{tagName} Associate components with a tag
TagsApi create2 POST /v1/tags Create a tag
TagsApi delete3 DELETE /v1/tags/{name} Delete a tag
TagsApi disassociate DELETE /v1/tags/associate/{tagName} Disassociate components from a tag
TagsApi get2 GET /v1/tags/{name} Get a tag
TagsApi get_tags GET /v1/tags List tags
TagsApi replace PUT /v1/tags/{name} Update a tags attributes
TasksApi create_task POST /v1/tasks Create task
TasksApi delete_task_by_id DELETE /v1/tasks/{id} Delete task by id
TasksApi get_task_by_id GET /v1/tasks/{id} Get a single task by id
TasksApi get_task_template GET /v1/tasks/templates/{typeId} Get task template by type. This is the base to create new tasks
TasksApi get_task_templates GET /v1/tasks/templates List tasks of template tasks. This is the base to create new tasks
TasksApi get_tasks GET /v1/tasks List tasks
TasksApi run POST /v1/tasks/{id}/run Run task
TasksApi stop POST /v1/tasks/{id}/stop Stop task
TasksApi update_task PUT /v1/tasks/{taskId} Update an existing task
UsageHistoryApi get_usage_history GET /v1/usage-history Get usage history for sparklines
AssetsApi delete_asset DELETE /v1/assets/{id} Delete a single asset
AssetsApi get_asset_by_id GET /v1/assets/{id} Get a single asset
AssetsApi get_assets GET /v1/assets List assets
ComponentsApi delete_component DELETE /v1/components/{id} Delete a single component
ComponentsApi get_component_by_id GET /v1/components/{id} Get a single component
ComponentsApi get_components GET /v1/components List components
ComponentsApi upload_component POST /v1/components Upload a single component

Documentation For Models

Documentation For Authorization

Authentication schemes defined for the API:

BasicAuth

  • Type: HTTP basic authentication

Author

community@sonatype.com

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

nexus_api_client-3.92.1.tar.gz (324.4 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

nexus_api_client-3.92.1-py3-none-any.whl (663.0 kB view details)

Uploaded Python 3

File details

Details for the file nexus_api_client-3.92.1.tar.gz.

File metadata

  • Download URL: nexus_api_client-3.92.1.tar.gz
  • Upload date:
  • Size: 324.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/2.2.1 CPython/3.12.13 Linux/6.17.0-1010-azure

File hashes

Hashes for nexus_api_client-3.92.1.tar.gz
Algorithm Hash digest
SHA256 fc72a84c9cefaf6dc06147f60482f8e5eff358f42f004899db762b6aef30e8a3
MD5 5c0f79fd55db5a32779b00c225e2a557
BLAKE2b-256 f145bd8ccbbcf079c8d18c8d8e51676c4f9f0f56ff0fba16fd973c069a0bd932

See more details on using hashes here.

File details

Details for the file nexus_api_client-3.92.1-py3-none-any.whl.

File metadata

  • Download URL: nexus_api_client-3.92.1-py3-none-any.whl
  • Upload date:
  • Size: 663.0 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/2.2.1 CPython/3.12.13 Linux/6.17.0-1010-azure

File hashes

Hashes for nexus_api_client-3.92.1-py3-none-any.whl
Algorithm Hash digest
SHA256 e543f82a779280be6d1ff02a53628cabf20491656112b08e2423d2a7f792f03a
MD5 bb38567a7638b40884b77c76b17ea621
BLAKE2b-256 86fba1f3f144267d153ea5b11eb9059ed2798dbb81e3be45e0d52204c2a9da17

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page