Kubeapps is a web-based UI for deploying and managing applications in Kubernetes clusters. Note: this API documentation is still in an initial stage and is subject to change. Before coupling to it, please drop us an issue or reach us via Slack to know more about your use case and see how we can assist you. #### Developer Documentation - The Kubeapps architecture overview. - The Kubeapps Developer Documentation for instructions on setting up the developer environment for developing on Kubeapps and its components. - The Kubeapps Build Guide for instructions on setting up the build environment and building Kubeapps from source.
This Python package is automatically generated by the Swagger Codegen project:
- API version: 0.1.0
- Package version: 1.0.1
- Build package: io.swagger.codegen.v3.generators.python.PythonClientCodegen
Python 2.7 and 3.4+
If the python package is hosted on Github, you can install directly from Github
pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git(you may need to run pip with root permission: sudo pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git)
Then import the package:
import kubeapps_client 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 kubeapps_clientPlease follow the installation procedure and then run the following:
from __future__ import print_function
import time
import kubeapps_client
from kubeapps_client.rest import ApiException
from pprint import pprint
# Configure API key authorization: ApiKeyAuth
configuration = kubeapps_client.Configuration()
configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['Authorization'] = 'Bearer'
# create an instance of the API class
api_instance = kubeapps_client.FluxV2PackagesServiceApi(kubeapps_client.ApiClient(configuration))
body = kubeapps_client.V1alpha1CreateInstalledPackageRequest() # V1alpha1CreateInstalledPackageRequest | Request for CreateInstalledPackage
try:
# CreateInstalledPackage creates an installed package based on the request.
api_response = api_instance.flux_v2_packages_service_create_installed_package(body)
pprint(api_response)
except ApiException as e:
print("Exception when calling FluxV2PackagesServiceApi->flux_v2_packages_service_create_installed_package: %s\n" % e)
# Configure API key authorization: ApiKeyAuth
configuration = kubeapps_client.Configuration()
configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['Authorization'] = 'Bearer'
# create an instance of the API class
api_instance = kubeapps_client.FluxV2PackagesServiceApi(kubeapps_client.ApiClient(configuration))
installed_package_ref_context_cluster = 'installed_package_ref_context_cluster_example' # str | Cluster A cluster name can be provided to target a specific cluster if multiple clusters are configured, otherwise all clusters will be assumed.
installed_package_ref_context_namespace = 'installed_package_ref_context_namespace_example' # str | Namespace A namespace must be provided if the context of the operation is for a resource or resources in a particular namespace. For requests to list items, not including a namespace here implies that the context for the request is everything the requesting user can read, though the result can be filtered by any filtering options of the request. Plugins may choose to return Unimplemented for some queries for which we do not yet have a need.
installed_package_ref_identifier = 'installed_package_ref_identifier_example' # str | The fully qualified identifier for the installed package (ie. a unique name for the context).
installed_package_ref_plugin_name = 'installed_package_ref_plugin_name_example' # str | Plugin name The name of the plugin, such as `fluxv2.packages` or `kapp_controller.packages`. (optional)
installed_package_ref_plugin_version = 'installed_package_ref_plugin_version_example' # str | Plugin version The version of the plugin, such as v1alpha1 (optional)
try:
# DeleteInstalledPackage deletes an installed package based on the request.
api_response = api_instance.flux_v2_packages_service_delete_installed_package(installed_package_ref_context_cluster, installed_package_ref_context_namespace, installed_package_ref_identifier, installed_package_ref_plugin_name=installed_package_ref_plugin_name, installed_package_ref_plugin_version=installed_package_ref_plugin_version)
pprint(api_response)
except ApiException as e:
print("Exception when calling FluxV2PackagesServiceApi->flux_v2_packages_service_delete_installed_package: %s\n" % e)
# Configure API key authorization: ApiKeyAuth
configuration = kubeapps_client.Configuration()
configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['Authorization'] = 'Bearer'
# create an instance of the API class
api_instance = kubeapps_client.FluxV2PackagesServiceApi(kubeapps_client.ApiClient(configuration))
available_package_ref_context_cluster = 'available_package_ref_context_cluster_example' # str | Cluster A cluster name can be provided to target a specific cluster if multiple clusters are configured, otherwise all clusters will be assumed.
available_package_ref_context_namespace = 'available_package_ref_context_namespace_example' # str | Namespace A namespace must be provided if the context of the operation is for a resource or resources in a particular namespace. For requests to list items, not including a namespace here implies that the context for the request is everything the requesting user can read, though the result can be filtered by any filtering options of the request. Plugins may choose to return Unimplemented for some queries for which we do not yet have a need.
available_package_ref_identifier = 'available_package_ref_identifier_example' # str | Available package identifier The fully qualified identifier for the available package (ie. a unique name for the context). For some packaging systems (particularly those where an available package is backed by a CR) this will just be the name, but for others such as those where an available package is not backed by a CR (eg. standard helm) it may be necessary to include the repository in the name or even the repo namespace to ensure this is unique. For example two helm repositories can define an \"apache\" chart that is available globally, the names would need to encode that to be unique (ie. \"repoA:apache\" and \"repoB:apache\").
available_package_ref_plugin_name = 'available_package_ref_plugin_name_example' # str | Plugin name The name of the plugin, such as `fluxv2.packages` or `kapp_controller.packages`. (optional)
available_package_ref_plugin_version = 'available_package_ref_plugin_version_example' # str | Plugin version The version of the plugin, such as v1alpha1 (optional)
pkg_version = 'pkg_version_example' # str | Optional specific version (or version reference) to request. By default the latest version (or latest version matching the reference) will be returned. (optional)
try:
# GetAvailablePackageDetail returns the package metadata managed by the 'fluxv2' plugin
api_response = api_instance.flux_v2_packages_service_get_available_package_detail(available_package_ref_context_cluster, available_package_ref_context_namespace, available_package_ref_identifier, available_package_ref_plugin_name=available_package_ref_plugin_name, available_package_ref_plugin_version=available_package_ref_plugin_version, pkg_version=pkg_version)
pprint(api_response)
except ApiException as e:
print("Exception when calling FluxV2PackagesServiceApi->flux_v2_packages_service_get_available_package_detail: %s\n" % e)
# Configure API key authorization: ApiKeyAuth
configuration = kubeapps_client.Configuration()
configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['Authorization'] = 'Bearer'
# create an instance of the API class
api_instance = kubeapps_client.FluxV2PackagesServiceApi(kubeapps_client.ApiClient(configuration))
context_cluster = 'context_cluster_example' # str | Cluster A cluster name can be provided to target a specific cluster if multiple clusters are configured, otherwise all clusters will be assumed. (optional)
context_namespace = 'context_namespace_example' # str | Namespace A namespace must be provided if the context of the operation is for a resource or resources in a particular namespace. For requests to list items, not including a namespace here implies that the context for the request is everything the requesting user can read, though the result can be filtered by any filtering options of the request. Plugins may choose to return Unimplemented for some queries for which we do not yet have a need. (optional)
filter_options_query = 'filter_options_query_example' # str | Text query Text query for the request (optional)
filter_options_categories = ['filter_options_categories_example'] # list[str] | Categories Collection of categories for the request (optional)
filter_options_repositories = ['filter_options_repositories_example'] # list[str] | Repositories Collection of repositories where the packages belong to (optional)
filter_options_pkg_version = 'filter_options_pkg_version_example' # str | Package version Package version for the request (optional)
filter_options_app_version = 'filter_options_app_version_example' # str | App version Packaged app version for the request (optional)
pagination_options_page_token = 'pagination_options_page_token_example' # str | Page token The client uses this field to request a specific page of the list results. (optional)
pagination_options_page_size = 56 # int | Page size Clients use this field to specify the maximum number of results to be returned by the server. The server may further constrain the maximum number of results returned in a single page. If the page_size is 0, the server will decide the number of results to be returned. (optional)
try:
# GetAvailablePackageSummaries returns the available packages managed by the 'fluxv2' plugin
api_response = api_instance.flux_v2_packages_service_get_available_package_summaries(context_cluster=context_cluster, context_namespace=context_namespace, filter_options_query=filter_options_query, filter_options_categories=filter_options_categories, filter_options_repositories=filter_options_repositories, filter_options_pkg_version=filter_options_pkg_version, filter_options_app_version=filter_options_app_version, pagination_options_page_token=pagination_options_page_token, pagination_options_page_size=pagination_options_page_size)
pprint(api_response)
except ApiException as e:
print("Exception when calling FluxV2PackagesServiceApi->flux_v2_packages_service_get_available_package_summaries: %s\n" % e)
# Configure API key authorization: ApiKeyAuth
configuration = kubeapps_client.Configuration()
configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['Authorization'] = 'Bearer'
# create an instance of the API class
api_instance = kubeapps_client.FluxV2PackagesServiceApi(kubeapps_client.ApiClient(configuration))
available_package_ref_context_cluster = 'available_package_ref_context_cluster_example' # str | Cluster A cluster name can be provided to target a specific cluster if multiple clusters are configured, otherwise all clusters will be assumed.
available_package_ref_context_namespace = 'available_package_ref_context_namespace_example' # str | Namespace A namespace must be provided if the context of the operation is for a resource or resources in a particular namespace. For requests to list items, not including a namespace here implies that the context for the request is everything the requesting user can read, though the result can be filtered by any filtering options of the request. Plugins may choose to return Unimplemented for some queries for which we do not yet have a need.
available_package_ref_identifier = 'available_package_ref_identifier_example' # str | Available package identifier The fully qualified identifier for the available package (ie. a unique name for the context). For some packaging systems (particularly those where an available package is backed by a CR) this will just be the name, but for others such as those where an available package is not backed by a CR (eg. standard helm) it may be necessary to include the repository in the name or even the repo namespace to ensure this is unique. For example two helm repositories can define an \"apache\" chart that is available globally, the names would need to encode that to be unique (ie. \"repoA:apache\" and \"repoB:apache\").
available_package_ref_plugin_name = 'available_package_ref_plugin_name_example' # str | Plugin name The name of the plugin, such as `fluxv2.packages` or `kapp_controller.packages`. (optional)
available_package_ref_plugin_version = 'available_package_ref_plugin_version_example' # str | Plugin version The version of the plugin, such as v1alpha1 (optional)
pkg_version = 'pkg_version_example' # str | Optional version reference for which full version history is required. By default a summary of versions is returned as outlined in the response. Plugins can choose not to implement this and provide the summary only, it is provided for completeness only. (optional)
try:
# GetAvailablePackageVersions returns the package versions managed by the 'fluxv2' plugin
api_response = api_instance.flux_v2_packages_service_get_available_package_versions(available_package_ref_context_cluster, available_package_ref_context_namespace, available_package_ref_identifier, available_package_ref_plugin_name=available_package_ref_plugin_name, available_package_ref_plugin_version=available_package_ref_plugin_version, pkg_version=pkg_version)
pprint(api_response)
except ApiException as e:
print("Exception when calling FluxV2PackagesServiceApi->flux_v2_packages_service_get_available_package_versions: %s\n" % e)
# Configure API key authorization: ApiKeyAuth
configuration = kubeapps_client.Configuration()
configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['Authorization'] = 'Bearer'
# create an instance of the API class
api_instance = kubeapps_client.FluxV2PackagesServiceApi(kubeapps_client.ApiClient(configuration))
installed_package_ref_context_cluster = 'installed_package_ref_context_cluster_example' # str | Cluster A cluster name can be provided to target a specific cluster if multiple clusters are configured, otherwise all clusters will be assumed.
installed_package_ref_context_namespace = 'installed_package_ref_context_namespace_example' # str | Namespace A namespace must be provided if the context of the operation is for a resource or resources in a particular namespace. For requests to list items, not including a namespace here implies that the context for the request is everything the requesting user can read, though the result can be filtered by any filtering options of the request. Plugins may choose to return Unimplemented for some queries for which we do not yet have a need.
installed_package_ref_identifier = 'installed_package_ref_identifier_example' # str | The fully qualified identifier for the installed package (ie. a unique name for the context).
installed_package_ref_plugin_name = 'installed_package_ref_plugin_name_example' # str | Plugin name The name of the plugin, such as `fluxv2.packages` or `kapp_controller.packages`. (optional)
installed_package_ref_plugin_version = 'installed_package_ref_plugin_version_example' # str | Plugin version The version of the plugin, such as v1alpha1 (optional)
try:
# GetInstalledPackageDetail returns the requested installed package managed by the 'fluxv2' plugin
api_response = api_instance.flux_v2_packages_service_get_installed_package_detail(installed_package_ref_context_cluster, installed_package_ref_context_namespace, installed_package_ref_identifier, installed_package_ref_plugin_name=installed_package_ref_plugin_name, installed_package_ref_plugin_version=installed_package_ref_plugin_version)
pprint(api_response)
except ApiException as e:
print("Exception when calling FluxV2PackagesServiceApi->flux_v2_packages_service_get_installed_package_detail: %s\n" % e)
# Configure API key authorization: ApiKeyAuth
configuration = kubeapps_client.Configuration()
configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['Authorization'] = 'Bearer'
# create an instance of the API class
api_instance = kubeapps_client.FluxV2PackagesServiceApi(kubeapps_client.ApiClient(configuration))
installed_package_ref_context_cluster = 'installed_package_ref_context_cluster_example' # str | Cluster A cluster name can be provided to target a specific cluster if multiple clusters are configured, otherwise all clusters will be assumed.
installed_package_ref_context_namespace = 'installed_package_ref_context_namespace_example' # str | Namespace A namespace must be provided if the context of the operation is for a resource or resources in a particular namespace. For requests to list items, not including a namespace here implies that the context for the request is everything the requesting user can read, though the result can be filtered by any filtering options of the request. Plugins may choose to return Unimplemented for some queries for which we do not yet have a need.
installed_package_ref_identifier = 'installed_package_ref_identifier_example' # str | The fully qualified identifier for the installed package (ie. a unique name for the context).
installed_package_ref_plugin_name = 'installed_package_ref_plugin_name_example' # str | Plugin name The name of the plugin, such as `fluxv2.packages` or `kapp_controller.packages`. (optional)
installed_package_ref_plugin_version = 'installed_package_ref_plugin_version_example' # str | Plugin version The version of the plugin, such as v1alpha1 (optional)
try:
# GetInstalledPackageResourceRefs returns the references for the Kubernetes resources created by an installed package.
api_response = api_instance.flux_v2_packages_service_get_installed_package_resource_refs(installed_package_ref_context_cluster, installed_package_ref_context_namespace, installed_package_ref_identifier, installed_package_ref_plugin_name=installed_package_ref_plugin_name, installed_package_ref_plugin_version=installed_package_ref_plugin_version)
pprint(api_response)
except ApiException as e:
print("Exception when calling FluxV2PackagesServiceApi->flux_v2_packages_service_get_installed_package_resource_refs: %s\n" % e)
# Configure API key authorization: ApiKeyAuth
configuration = kubeapps_client.Configuration()
configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['Authorization'] = 'Bearer'
# create an instance of the API class
api_instance = kubeapps_client.FluxV2PackagesServiceApi(kubeapps_client.ApiClient(configuration))
context_cluster = 'context_cluster_example' # str | Cluster A cluster name can be provided to target a specific cluster if multiple clusters are configured, otherwise all clusters will be assumed. (optional)
context_namespace = 'context_namespace_example' # str | Namespace A namespace must be provided if the context of the operation is for a resource or resources in a particular namespace. For requests to list items, not including a namespace here implies that the context for the request is everything the requesting user can read, though the result can be filtered by any filtering options of the request. Plugins may choose to return Unimplemented for some queries for which we do not yet have a need. (optional)
pagination_options_page_token = 'pagination_options_page_token_example' # str | Page token The client uses this field to request a specific page of the list results. (optional)
pagination_options_page_size = 56 # int | Page size Clients use this field to specify the maximum number of results to be returned by the server. The server may further constrain the maximum number of results returned in a single page. If the page_size is 0, the server will decide the number of results to be returned. (optional)
try:
# GetInstalledPackageSummaries returns the installed packages managed by the 'fluxv2' plugin
api_response = api_instance.flux_v2_packages_service_get_installed_package_summaries(context_cluster=context_cluster, context_namespace=context_namespace, pagination_options_page_token=pagination_options_page_token, pagination_options_page_size=pagination_options_page_size)
pprint(api_response)
except ApiException as e:
print("Exception when calling FluxV2PackagesServiceApi->flux_v2_packages_service_get_installed_package_summaries: %s\n" % e)
# Configure API key authorization: ApiKeyAuth
configuration = kubeapps_client.Configuration()
configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['Authorization'] = 'Bearer'
# create an instance of the API class
api_instance = kubeapps_client.FluxV2PackagesServiceApi(kubeapps_client.ApiClient(configuration))
body = kubeapps_client.V1alpha1FluxV2PackagesServiceUpdateInstalledPackageBody() # V1alpha1FluxV2PackagesServiceUpdateInstalledPackageBody |
installed_package_ref_context_cluster = 'installed_package_ref_context_cluster_example' # str | Cluster A cluster name can be provided to target a specific cluster if multiple clusters are configured, otherwise all clusters will be assumed.
installed_package_ref_context_namespace = 'installed_package_ref_context_namespace_example' # str | Namespace A namespace must be provided if the context of the operation is for a resource or resources in a particular namespace. For requests to list items, not including a namespace here implies that the context for the request is everything the requesting user can read, though the result can be filtered by any filtering options of the request. Plugins may choose to return Unimplemented for some queries for which we do not yet have a need.
installed_package_ref_identifier = 'installed_package_ref_identifier_example' # str | The fully qualified identifier for the installed package (ie. a unique name for the context).
try:
# UpdateInstalledPackage updates an installed package based on the request.
api_response = api_instance.flux_v2_packages_service_update_installed_package(body, installed_package_ref_context_cluster, installed_package_ref_context_namespace, installed_package_ref_identifier)
pprint(api_response)
except ApiException as e:
print("Exception when calling FluxV2PackagesServiceApi->flux_v2_packages_service_update_installed_package: %s\n" % e)All URIs are relative to http://127.0.0.1:8080/apis
| Class | Method | HTTP request | Description |
|---|---|---|---|
| FluxV2PackagesServiceApi | flux_v2_packages_service_create_installed_package | POST /plugins/fluxv2/packages/v1alpha1/installedpackages | CreateInstalledPackage creates an installed package based on the request. |
| FluxV2PackagesServiceApi | flux_v2_packages_service_delete_installed_package | DELETE /plugins/fluxv2/packages/v1alpha1/installedpackages/c/{installedPackageRef.context.cluster}/ns/{installedPackageRef.context.namespace}/{installedPackageRef.identifier} | DeleteInstalledPackage deletes an installed package based on the request. |
| FluxV2PackagesServiceApi | flux_v2_packages_service_get_available_package_detail | GET /plugins/fluxv2/packages/v1alpha1/availablepackages/c/{availablePackageRef.context.cluster}/ns/{availablePackageRef.context.namespace}/{availablePackageRef.identifier} | GetAvailablePackageDetail returns the package metadata managed by the 'fluxv2' plugin |
| FluxV2PackagesServiceApi | flux_v2_packages_service_get_available_package_summaries | GET /plugins/fluxv2/packages/v1alpha1/availablepackages | GetAvailablePackageSummaries returns the available packages managed by the 'fluxv2' plugin |
| FluxV2PackagesServiceApi | flux_v2_packages_service_get_available_package_versions | GET /plugins/fluxv2/packages/v1alpha1/availablepackages/c/{availablePackageRef.context.cluster}/ns/{availablePackageRef.context.namespace}/{availablePackageRef.identifier}/versions | GetAvailablePackageVersions returns the package versions managed by the 'fluxv2' plugin |
| FluxV2PackagesServiceApi | flux_v2_packages_service_get_installed_package_detail | GET /plugins/fluxv2/packages/v1alpha1/installedpackages/c/{installedPackageRef.context.cluster}/ns/{installedPackageRef.context.namespace}/{installedPackageRef.identifier} | GetInstalledPackageDetail returns the requested installed package managed by the 'fluxv2' plugin |
| FluxV2PackagesServiceApi | flux_v2_packages_service_get_installed_package_resource_refs | GET /plugins/fluxv2/packages/v1alpha1/installedpackages/c/{installedPackageRef.context.cluster}/ns/{installedPackageRef.context.namespace}/{installedPackageRef.identifier}/resourcerefs | GetInstalledPackageResourceRefs returns the references for the Kubernetes resources created by an installed package. |
| FluxV2PackagesServiceApi | flux_v2_packages_service_get_installed_package_summaries | GET /plugins/fluxv2/packages/v1alpha1/installedpackages | GetInstalledPackageSummaries returns the installed packages managed by the 'fluxv2' plugin |
| FluxV2PackagesServiceApi | flux_v2_packages_service_update_installed_package | PUT /plugins/fluxv2/packages/v1alpha1/installedpackages/c/{installedPackageRef.context.cluster}/ns/{installedPackageRef.context.namespace}/{installedPackageRef.identifier} | UpdateInstalledPackage updates an installed package based on the request. |
| FluxV2RepositoriesServiceApi | flux_v2_repositories_service_add_package_repository | POST /plugins/fluxv2/packages/v1alpha1/repositories | AddPackageRepository add an existing package repository to the set of ones already managed by the 'fluxv2' plugin |
| FluxV2RepositoriesServiceApi | flux_v2_repositories_service_delete_package_repository | DELETE /plugins/fluxv2/packages/v1alpha1/repositories/c/{packageRepoRef.context.cluster}/ns/{packageRepoRef.context.namespace}/{packageRepoRef.identifier} | |
| FluxV2RepositoriesServiceApi | flux_v2_repositories_service_get_package_repository_detail | GET /plugins/fluxv2/packages/v1alpha1/repositories/c/{packageRepoRef.context.cluster}/ns/{packageRepoRef.context.namespace}/{packageRepoRef.identifier} | |
| FluxV2RepositoriesServiceApi | flux_v2_repositories_service_get_package_repository_permissions | GET /plugins/fluxv2/packages/v1alpha1/repositories/c/{context.cluster}/permissions | |
| FluxV2RepositoriesServiceApi | flux_v2_repositories_service_get_package_repository_summaries | GET /plugins/fluxv2/packages/v1alpha1/repositories | |
| FluxV2RepositoriesServiceApi | flux_v2_repositories_service_update_package_repository | PUT /plugins/fluxv2/packages/v1alpha1/repositories/c/{packageRepoRef.context.cluster}/ns/{packageRepoRef.context.namespace}/{packageRepoRef.identifier} | |
| HelmPackagesServiceApi | helm_packages_service_create_installed_package | POST /plugins/helm/packages/v1alpha1/installedpackages | CreateInstalledPackage creates an installed package based on the request. |
| HelmPackagesServiceApi | helm_packages_service_delete_installed_package | DELETE /plugins/helm/packages/v1alpha1/installedpackages/c/{installedPackageRef.context.cluster}/ns/{installedPackageRef.context.namespace}/{installedPackageRef.identifier} | DeleteInstalledPackage deletes an installed package based on the request. |
| HelmPackagesServiceApi | helm_packages_service_get_available_package_detail | GET /plugins/helm/packages/v1alpha1/availablepackages/c/{availablePackageRef.context.cluster}/ns/{availablePackageRef.context.namespace}/{availablePackageRef.identifier} | GetAvailablePackageDetail returns the package details managed by the 'helm' plugin |
| HelmPackagesServiceApi | helm_packages_service_get_available_package_summaries | GET /plugins/helm/packages/v1alpha1/availablepackages | GetAvailablePackageSummaries returns the available packages managed by the 'helm' plugin |
| HelmPackagesServiceApi | helm_packages_service_get_available_package_versions | GET /plugins/helm/packages/v1alpha1/availablepackages/c/{availablePackageRef.context.cluster}/ns/{availablePackageRef.context.namespace}/{availablePackageRef.identifier}/versions | GetAvailablePackageVersions returns the package versions managed by the 'helm' plugin |
| HelmPackagesServiceApi | helm_packages_service_get_installed_package_detail | GET /plugins/helm/packages/v1alpha1/installedpackages/c/{installedPackageRef.context.cluster}/ns/{installedPackageRef.context.namespace}/{installedPackageRef.identifier} | GetInstalledPackageDetail returns the requested installed package managed by the 'helm' plugin |
| HelmPackagesServiceApi | helm_packages_service_get_installed_package_resource_refs | GET /plugins/helm/packages/v1alpha1/installedpackages/c/{installedPackageRef.context.cluster}/ns/{installedPackageRef.context.namespace}/{installedPackageRef.identifier}/resourcerefs | GetInstalledPackageResourceRefs returns the references for the Kubernetes resources created by an installed package. |
| HelmPackagesServiceApi | helm_packages_service_get_installed_package_summaries | GET /plugins/helm/packages/v1alpha1/installedpackages | GetInstalledPackageSummaries returns the installed packages managed by the 'helm' plugin |
| HelmPackagesServiceApi | helm_packages_service_rollback_installed_package | PUT /plugins/helm/packages/v1alpha1/installedpackages/c/{installedPackageRef.context.cluster}/ns/{installedPackageRef.context.namespace}/{installedPackageRef.identifier}/rollback | RollbackInstalledPackage updates an installed package based on the request. |
| HelmPackagesServiceApi | helm_packages_service_update_installed_package | PUT /plugins/helm/packages/v1alpha1/installedpackages/c/{installedPackageRef.context.cluster}/ns/{installedPackageRef.context.namespace}/{installedPackageRef.identifier} | UpdateInstalledPackage updates an installed package based on the request. |
| HelmRepositoriesServiceApi | helm_repositories_service_add_package_repository | POST /plugins/helm/packages/v1alpha1/repositories | AddPackageRepository add an existing package repository to the set of ones already managed by the Helm plugin |
| HelmRepositoriesServiceApi | helm_repositories_service_delete_package_repository | DELETE /plugins/helm/packages/v1alpha1/repositories/c/{packageRepoRef.context.cluster}/ns/{packageRepoRef.context.namespace}/{packageRepoRef.identifier} | |
| HelmRepositoriesServiceApi | helm_repositories_service_get_package_repository_detail | GET /plugins/helm/packages/v1alpha1/repositories/c/{packageRepoRef.context.cluster}/ns/{packageRepoRef.context.namespace}/{packageRepoRef.identifier} | |
| HelmRepositoriesServiceApi | helm_repositories_service_get_package_repository_permissions | GET /plugins/helm/packages/v1alpha1/repositories/c/{context.cluster}/permissions | |
| HelmRepositoriesServiceApi | helm_repositories_service_get_package_repository_summaries | GET /plugins/helm/packages/v1alpha1/repositories | |
| HelmRepositoriesServiceApi | helm_repositories_service_update_package_repository | PUT /plugins/helm/packages/v1alpha1/repositories/c/{packageRepoRef.context.cluster}/ns/{packageRepoRef.context.namespace}/{packageRepoRef.identifier} | |
| KappControllerPackagesServiceApi | kapp_controller_packages_service_create_installed_package | POST /plugins/kapp_controller/packages/v1alpha1/installedpackages | CreateInstalledPackage creates an installed package based on the request. |
| KappControllerPackagesServiceApi | kapp_controller_packages_service_delete_installed_package | DELETE /plugins/kapp_controller/packages/v1alpha1/installedpackages/c/{installedPackageRef.context.cluster}/ns/{installedPackageRef.context.namespace}/{installedPackageRef.identifier} | DeleteInstalledPackage deletes an installed package based on the request. |
| KappControllerPackagesServiceApi | kapp_controller_packages_service_get_available_package_detail | GET /plugins/kapp_controller/packages/v1alpha1/availablepackages/c/{availablePackageRef.context.cluster}/ns/{availablePackageRef.context.namespace}/{availablePackageRef.identifier} | GetAvailablePackageDetail returns the package details managed by the 'kapp_controller' plugin |
| KappControllerPackagesServiceApi | kapp_controller_packages_service_get_available_package_summaries | GET /plugins/kapp_controller/packages/v1alpha1/availablepackages | GetAvailablePackageSummaries returns the available packages managed by the 'kapp_controller' plugin |
| KappControllerPackagesServiceApi | kapp_controller_packages_service_get_available_package_versions | GET /plugins/kapp_controller/packages/v1alpha1/availablepackages/c/{availablePackageRef.context.cluster}/ns/{availablePackageRef.context.namespace}/{availablePackageRef.identifier}/versions | GetAvailablePackageVersions returns the package versions managed by the 'kapp_controller' plugin |
| KappControllerPackagesServiceApi | kapp_controller_packages_service_get_installed_package_detail | GET /plugins/kapp_controller/packages/v1alpha1/installedpackages/c/{installedPackageRef.context.cluster}/ns/{installedPackageRef.context.namespace}/{installedPackageRef.identifier} | GetInstalledPackageDetail returns the requested installed package managed by the 'kapp_controller' plugin |
| KappControllerPackagesServiceApi | kapp_controller_packages_service_get_installed_package_resource_refs | GET /plugins/kapp_controller/packages/v1alpha1/installedpackages/c/{installedPackageRef.context.cluster}/ns/{installedPackageRef.context.namespace}/{installedPackageRef.identifier}/resourcerefs | GetInstalledPackageResourceRefs returns the references for the Kubernetes resources created by an installed package. |
| KappControllerPackagesServiceApi | kapp_controller_packages_service_get_installed_package_summaries | GET /plugins/kapp_controller/packages/v1alpha1/installedpackages | GetInstalledPackageSummaries returns the installed packages managed by the 'kapp_controller' plugin |
| KappControllerPackagesServiceApi | kapp_controller_packages_service_update_installed_package | PUT /plugins/kapp_controller/packages/v1alpha1/installedpackages/c/{installedPackageRef.context.cluster}/ns/{installedPackageRef.context.namespace}/{installedPackageRef.identifier} | UpdateInstalledPackage updates an installed package based on the request. |
| KappControllerRepositoriesServiceApi | kapp_controller_repositories_service_add_package_repository | POST /plugins/kapp_controller/packages/v1alpha1/repositories | AddPackageRepository add an existing package repository to the set of ones already managed by the 'kapp_controller' plugin |
| KappControllerRepositoriesServiceApi | kapp_controller_repositories_service_delete_package_repository | DELETE /plugins/kapp_controller/packages/v1alpha1/repositories/c/{packageRepoRef.context.cluster}/ns/{packageRepoRef.context.namespace}/{packageRepoRef.identifier} | |
| KappControllerRepositoriesServiceApi | kapp_controller_repositories_service_get_package_repository_detail | GET /plugins/kapp_controller/packages/v1alpha1/repositories/c/{packageRepoRef.context.cluster}/ns/{packageRepoRef.context.namespace}/{packageRepoRef.identifier} | |
| KappControllerRepositoriesServiceApi | kapp_controller_repositories_service_get_package_repository_permissions | GET /plugins/kapp_controller/packages/v1alpha1/repositories/c/{context.cluster}/permissions | |
| KappControllerRepositoriesServiceApi | kapp_controller_repositories_service_get_package_repository_summaries | GET /plugins/kapp_controller/packages/v1alpha1/repositories | |
| KappControllerRepositoriesServiceApi | kapp_controller_repositories_service_update_package_repository | PUT /plugins/kapp_controller/packages/v1alpha1/repositories/c/{packageRepoRef.context.cluster}/ns/{packageRepoRef.context.namespace}/{packageRepoRef.identifier} | |
| PackagesServiceApi | packages_service_create_installed_package | POST /core/packages/v1alpha1/installedpackages | |
| PackagesServiceApi | packages_service_delete_installed_package | DELETE /core/packages/v1alpha1/installedpackages/plugin/{installedPackageRef.plugin.name}/{installedPackageRef.plugin.version}/c/{installedPackageRef.context.cluster}/ns/{installedPackageRef.context.namespace}/{installedPackageRef.identifier} | |
| PackagesServiceApi | packages_service_get_available_package_detail | GET /core/packages/v1alpha1/availablepackages/plugin/{availablePackageRef.plugin.name}/{availablePackageRef.plugin.version}/c/{availablePackageRef.context.cluster}/ns/{availablePackageRef.context.namespace}/{availablePackageRef.identifier} | |
| PackagesServiceApi | packages_service_get_available_package_metadatas | GET /core/packages/v1alpha1/availablepackages/plugin/{availablePackageRef.plugin.name}/{availablePackageRef.plugin.version}/c/{availablePackageRef.context.cluster}/ns/{availablePackageRef.context.namespace}/{availablePackageRef.identifier}/metadata | |
| PackagesServiceApi | packages_service_get_available_package_summaries | GET /core/packages/v1alpha1/availablepackages | |
| PackagesServiceApi | packages_service_get_available_package_versions | GET /core/packages/v1alpha1/availablepackages/plugin/{availablePackageRef.plugin.name}/{availablePackageRef.plugin.version}/c/{availablePackageRef.context.cluster}/ns/{availablePackageRef.context.namespace}/{availablePackageRef.identifier}/versions | |
| PackagesServiceApi | packages_service_get_installed_package_detail | GET /core/packages/v1alpha1/installedpackages/plugin/{installedPackageRef.plugin.name}/{installedPackageRef.plugin.version}/c/{installedPackageRef.context.cluster}/ns/{installedPackageRef.context.namespace}/{installedPackageRef.identifier} | |
| PackagesServiceApi | packages_service_get_installed_package_resource_refs | GET /core/packages/v1alpha1/installedpackages/plugin/{installedPackageRef.plugin.name}/{installedPackageRef.plugin.version}/c/{installedPackageRef.context.cluster}/ns/{installedPackageRef.context.namespace}/{installedPackageRef.identifier}/resourcerefs | |
| PackagesServiceApi | packages_service_get_installed_package_summaries | GET /core/packages/v1alpha1/installedpackages | |
| PackagesServiceApi | packages_service_update_installed_package | PUT /core/packages/v1alpha1/installedpackages/plugin/{installedPackageRef.plugin.name}/{installedPackageRef.plugin.version}/c/{installedPackageRef.context.cluster}/ns/{installedPackageRef.context.namespace}/{installedPackageRef.identifier} | |
| PluginsServiceApi | plugins_service_get_configured_plugins | GET /core/plugins/v1alpha1/configured-plugins | GetConfiguredPlugins returns a map of short and longnames for the configured plugins. |
| RepositoriesServiceApi | repositories_service_add_package_repository | POST /core/packages/v1alpha1/repositories | |
| RepositoriesServiceApi | repositories_service_delete_package_repository | DELETE /core/packages/v1alpha1/repositories/plugin/{packageRepoRef.plugin.name}/{packageRepoRef.plugin.version}/c/{packageRepoRef.context.cluster}/ns/{packageRepoRef.context.namespace}/{packageRepoRef.identifier} | |
| RepositoriesServiceApi | repositories_service_get_package_repository_detail | GET /core/packages/v1alpha1/repositories/plugin/{packageRepoRef.plugin.name}/{packageRepoRef.plugin.version}/c/{packageRepoRef.context.cluster}/ns/{packageRepoRef.context.namespace}/{packageRepoRef.identifier} | |
| RepositoriesServiceApi | repositories_service_get_package_repository_permissions | GET /core/packages/v1alpha1/repositories/c/{context.cluster}/permissions | |
| RepositoriesServiceApi | repositories_service_get_package_repository_summaries | GET /core/packages/v1alpha1/repositories | |
| RepositoriesServiceApi | repositories_service_update_package_repository | PUT /core/packages/v1alpha1/repositories/plugin/{packageRepoRef.plugin.name}/{packageRepoRef.plugin.version}/c/{packageRepoRef.context.cluster}/ns/{packageRepoRef.context.namespace}/{packageRepoRef.identifier} | |
| ResourcesServiceApi | resources_service_can_i | POST /plugins/resources/v1alpha1/c/{context.cluster}/can-i | |
| ResourcesServiceApi | resources_service_check_namespace_exists | GET /plugins/resources/v1alpha1/c/{context.cluster}/ns/{context.namespace} | |
| ResourcesServiceApi | resources_service_create_namespace | POST /plugins/resources/v1alpha1/c/{context.cluster}/ns | |
| ResourcesServiceApi | resources_service_create_secret | POST /plugins/resources/v1alpha1/c/{context.cluster}/ns/{context.namespace}/secrets | |
| ResourcesServiceApi | resources_service_get_namespace_names | GET /plugins/resources/v1alpha1/c/{cluster}/namespacenames | |
| ResourcesServiceApi | resources_service_get_resources | GET /plugins/resources/v1alpha1/{installedPackageRef.plugin.name}/{installedPackageRef.plugin.version}/c/{installedPackageRef.context.cluster}/ns/{installedPackageRef.context.namespace}/{installedPackageRef.identifier} | |
| ResourcesServiceApi | resources_service_get_secret_names | GET /plugins/resources/v1alpha1/c/{context.cluster}/ns/{context.namespace}/secretnames | |
| ResourcesServiceApi | resources_service_get_service_account_names | GET /plugins/resources/v1alpha1/c/{context.cluster}/ns/{context.namespace}/serviceaccountnames |
- AReferenceUniquelyIdentifyingTheInstalledPackageBeingUpdatedRequired
- AReferenceUniquelyIdentifyingTheInstalledPackageBeingUpdatedRequired1
- AReferenceUniquelyIdentifyingThePackageRepositoryBeingUpdatedTheOnlyRequiredField
- AReferenceUniquelyIdentifyingThePackageRepositoryBeingUpdatedTheOnlyRequiredField1
- HelmPackagesServiceRollbackInstalledPackageBody
- InstalledPackageReference
- PackageRepositoryAuthPackageRepositoryAuthType
- ProtobufAny
- RpcStatus
- StreamResultOfV1alpha1GetResourcesResponse
- V1alpha1AddPackageRepositoryRequest
- V1alpha1AddPackageRepositoryResponse
- V1alpha1AvailablePackageDetail
- V1alpha1AvailablePackageReference
- V1alpha1AvailablePackageSummary
- V1alpha1CanIResponse
- V1alpha1CheckNamespaceExistsResponse
- V1alpha1Context
- V1alpha1CreateInstalledPackageRequest
- V1alpha1CreateInstalledPackageResponse
- V1alpha1CreateNamespaceResponse
- V1alpha1CreateSecretResponse
- V1alpha1DeleteInstalledPackageResponse
- V1alpha1DeletePackageRepositoryResponse
- V1alpha1DockerCredentials
- V1alpha1FilterOptions
- V1alpha1FluxV2PackagesServiceUpdateInstalledPackageBody
- V1alpha1FluxV2RepositoriesServiceUpdatePackageRepositoryBody
- V1alpha1GetAvailablePackageDetailResponse
- V1alpha1GetAvailablePackageMetadatasResponse
- V1alpha1GetAvailablePackageSummariesResponse
- V1alpha1GetAvailablePackageVersionsResponse
- V1alpha1GetConfiguredPluginsResponse
- V1alpha1GetInstalledPackageDetailResponse
- V1alpha1GetInstalledPackageResourceRefsResponse
- V1alpha1GetInstalledPackageSummariesResponse
- V1alpha1GetNamespaceNamesResponse
- V1alpha1GetPackageRepositoryDetailResponse
- V1alpha1GetPackageRepositoryPermissionsResponse
- V1alpha1GetPackageRepositorySummariesResponse
- V1alpha1GetResourcesResponse
- V1alpha1GetSecretNamesResponse
- V1alpha1GetServiceAccountNamesResponse
- V1alpha1HelmPackagesServiceUpdateInstalledPackageBody
- V1alpha1HelmRepositoriesServiceUpdatePackageRepositoryBody
- V1alpha1InstalledPackageDetail
- V1alpha1InstalledPackageReference
- V1alpha1InstalledPackageStatus
- V1alpha1InstalledPackageStatusStatusReason
- V1alpha1InstalledPackageSummary
- V1alpha1KappControllerPackagesServiceUpdateInstalledPackageBody
- V1alpha1KappControllerRepositoriesServiceUpdatePackageRepositoryBody
- V1alpha1Maintainer
- V1alpha1OpaqueCredentials
- V1alpha1PackageAppVersion
- V1alpha1PackageMetadata
- V1alpha1PackageRepositoriesPermissions
- V1alpha1PackageRepositoryAuth
- V1alpha1PackageRepositoryDetail
- V1alpha1PackageRepositoryReference
- V1alpha1PackageRepositoryStatus
- V1alpha1PackageRepositoryStatusStatusReason
- V1alpha1PackageRepositorySummary
- V1alpha1PackageRepositoryTlsConfig
- V1alpha1PackagesServiceUpdateInstalledPackageBody
- V1alpha1PaginationOptions
- V1alpha1Plugin
- V1alpha1ReconciliationOptions
- V1alpha1RepositoriesServiceUpdatePackageRepositoryBody
- V1alpha1ResourceRef
- V1alpha1RollbackInstalledPackageResponse
- V1alpha1SecretKeyReference
- V1alpha1SecretType
- V1alpha1SshCredentials
- V1alpha1TlsCertKey
- V1alpha1UpdateInstalledPackageResponse
- V1alpha1UpdatePackageRepositoryResponse
- V1alpha1UsernamePassword
- V1alpha1VersionReference
- Type: API key
- API key parameter name: Authorization
- Location: HTTP header