Package: ionoscloud-container-registry
Python API client for ionoscloud_container_registryOverviewContainer Registry service enables IONOS clients to manage docker and OCI
compliant registries for use by their managed Kubernetes clusters. Use a
Container Registry to ensure you have a privately accessed registry to
efficiently support image pulls.Changelog1.1.0Added new endpoints for RepositoriesAdded new endpoints for ArtifactsAdded new endpoints for VulnerabilitiesAdded registry vulnerabilityScanning featureOverviewThe IONOS Cloud SDK for Python provides you with access to the IONOS Cloud API. The client library supports both simple and complex requests. It is designed for developers who are building applications in Python. All API operations are performed over SSL and authenticated using your IONOS Cloud portal credentials. The API can be accessed within an instance running in IONOS Cloud or directly over the Internet from any application that can send an HTTPS request and receive an HTTPS response.Installation & UsageRequirements:Python >= 3.5pip installSince this package is hosted onPypiyou can install it by using:pipinstallionoscloud-container-registryIf the python package is hosted on a repository, you can install directly using:pipinstallgit+https://github.com/ionos-cloud/sdk-python-container-registry.gitNote: you may need to runpipwith root permission:sudo pip install git+https://github.com/ionos-cloud/sdk-python-container-registry.gitThen import the package:importionoscloud_container_registrySetuptoolsInstall viaSetuptools.pythonsetup.pyinstall--userorsudo python setup.py installto install the package for all usersThen import the package:importionoscloud_container_registryNOTE:The Python SDK does not support Python 2. It only supports Python >= 3.5.AuthenticationThe username and passwordorthe authentication token can be manually specified when initializing the SDK client:configuration=ionoscloud_container_registry.Configuration(username='YOUR_USERNAME',password='YOUR_PASSWORD',token='YOUR_TOKEN')client=ionoscloud_container_registry.ApiClient(configuration)Environment variables can also be used. This is an example of how one would do that:importosconfiguration=ionoscloud_container_registry.Configuration(username=os.environ.get('IONOS_USERNAME'),password=os.environ.get('IONOS_PASSWORD'),token=os.environ.get('IONOS_TOKEN'))client=ionoscloud_container_registry.ApiClient(configuration)Warning: Make sure to follow the Information Security Best Practices when using credentials within your code or storing them in a file.HTTP proxiesYou can use http proxies by setting the following environment variables:IONOS_HTTP_PROXY- proxy URLIONOS_HTTP_PROXY_HEADERS- proxy headersEach line inIONOS_HTTP_PROXY_HEADERSrepresents one header, where the header name and value is separated by a colon. Newline characters within a value need to be escaped. See this example:Connection: Keep-Alive
User-Info: MyID
User-Group: my long\nheader valueChanging the base URLBase URL for the HTTP operation can be changed in the following way:importosconfiguration=ionoscloud_container_registry.Configuration(username=os.environ.get('IONOS_USERNAME'),password=os.environ.get('IONOS_PASSWORD'),host=os.environ.get('IONOS_API_URL'),server_index=None,)client=ionoscloud_container_registry.ApiClient(configuration)Certificate pinning:You can enable certificate pinning if you want to bypass the normal certificate checking procedure,
by doing the following:Set env variable IONOS_PINNED_CERT=<insert_sha256_public_fingerprint_here>You can get the sha256 fingerprint most easily from the browser by inspecting the certificate.Documentation for API EndpointsAll URIs are relative tohttps://api.ionos.com/containerregistriesAPI Endpoints tableClassMethodHTTP requestDescriptionArtifactsApiregistries_artifacts_getGET/registries/{registryId}/artifactsRetrieve all Artifacts by RegistryArtifactsApiregistries_repositories_artifacts_find_by_digestGET/registries/{registryId}/repositories/{repositoryName}/artifacts/{digest}Retrieve ArtifactArtifactsApiregistries_repositories_artifacts_getGET/registries/{registryId}/repositories/{repositoryName}/artifactsRetrieve all Artifacts by RepositoryArtifactsApiregistries_repositories_artifacts_vulnerabilities_getGET/registries/{registryId}/repositories/{repositoryName}/artifacts/{digest}/vulnerabilitiesRetrieve all VulnerabilitiesLocationsApilocations_getGET/locationsGet container registry locationsNamesApinames_check_usageHEAD/names/{name}Get container registry name availabilityRegistriesApiregistries_deleteDELETE/registries/{registryId}Delete registryRegistriesApiregistries_find_by_idGET/registries/{registryId}Get a registryRegistriesApiregistries_getGET/registriesList all container registriesRegistriesApiregistries_patchPATCH/registries/{registryId}Update the properties of a registryRegistriesApiregistries_postPOST/registriesCreate container registryRegistriesApiregistries_putPUT/registries/{registryId}Create or replace a container registryRepositoriesApiregistries_repositories_deleteDELETE/registries/{registryId}/repositories/{repositoryName}Delete repositoryRepositoriesApiregistries_repositories_find_by_nameGET/registries/{registryId}/repositories/{repositoryName}Retrieve RepositoryRepositoriesApiregistries_repositories_getGET/registries/{registryId}/repositoriesRetrieve all RepositoriesTokensApiregistries_tokens_deleteDELETE/registries/{registryId}/tokens/{tokenId}Delete tokenTokensApiregistries_tokens_find_by_idGET/registries/{registryId}/tokens/{tokenId}Get token informationTokensApiregistries_tokens_getGET/registries/{registryId}/tokensList all tokens for the container registryTokensApiregistries_tokens_patchPATCH/registries/{registryId}/tokens/{tokenId}Update tokenTokensApiregistries_tokens_postPOST/registries/{registryId}/tokensCreate tokenTokensApiregistries_tokens_putPUT/registries/{registryId}/tokens/{tokenId}Create or replace tokenVulnerabilitiesApivulnerabilities_find_by_idGET/vulnerabilities/{vulnerabilityId}Retrieve VulnerabilityDocumentation For ModelsAll URIs are relative tohttps://api.ionos.com/containerregistriesAPI models listApiErrorMessageApiErrorResponseApiResourceMetadataArtifactArtifactMetadataArtifactMetadataAllOfArtifactReadArtifactReadListArtifactVulnerabilityReadListCredentialsDayErrorErrorMessagesFeatureFeatureVulnerabilityScanningLinksLocationLocationsResponseMetadataPaginationPaginationLinksPatchRegistryInputPatchTokenInputPostRegistryInputPostRegistryOutputPostRegistryPropertiesPostTokenInputPostTokenOutputPostTokenPropertiesPurlPutRegistryInputPutRegistryOutputPutTokenInputPutTokenOutputRegistriesResponseRegistryArtifactsReadListRegistryFeaturesRegistryPaginationRegistryPropertiesRegistryResponseRepositoryRepositoryMetadataRepositoryMetadataAllOfRepositoryReadRepositoryReadListScopeStorageUsageTokenPropertiesTokenResponseTokensResponseVulnerabilityVulnerabilityDataSourceVulnerabilityMetadataVulnerabilityReadVulnerabilityReadListWeeklySchedule[Back to API list][Back to Model list]