--- title: "Get a helm release" method: GET path: "/endpoints/{id}/kubernetes/helm/{release}" tags: ["helm"] --- # Get a helm release `GET /endpoints/{id}/kubernetes/helm/{release}` Get details of a helm release by release name **Access policy**: authenticated ## Path parameters - `id` integer, required - `release` string, required ## Query parameters - `namespace` string - `showResources` boolean - `revision` integer ## Response `200` Success - ReleaseRelease - `appVersion` string — AppVersion is the app version of the release. - `chart` ReleaseChart - `files` ReleaseFile[] — Files are miscellaneous files in a chart archive, e.g. README, LICENSE, etc. - `data` integer[] — Data is the template as byte data. - `name` string — Name is the path-like name of the template. - `lock` ReleaseLock - `dependencies` ReleaseDependency[] — Dependencies is the list of dependencies that this lock file has locked. - `alias` string — Alias usable alias to be used for the chart - `condition` string — A yaml path that resolves to a boolean, used for enabling/disabling charts (e.g. subchart1.enabled ) - `enabled` boolean — Enabled bool determines if chart should be loaded - `import-values` unknown[] — ImportValues holds the mapping of source values to parent key to be imported. Each item can be a string or pair of child/parent sublist items. - unknown - `name` string — Name is the name of the dependency. This must mach the name in the dependency's Chart.yaml. - `repository` string — The URL to the repository. Appending `index.yaml` to this string should result in a URL that can be used to fetch the repository index. - `tags` string[] — Tags can be used to group charts for enabling/disabling together - `version` string — Version is the version (range) of this chart. A lock file will always produce a single version, while a dependency may contain a semantic version range. - `digest` string — Digest is a hash of the dependencies in Chart.yaml. - `generated` string — Generated is the date the lock file was last generated. - `metadata` ReleaseMetadata - `annotations` object — Annotations are additional mappings uninterpreted by Helm, made available for inspection by other applications. - `apiVersion` string — The API Version of this chart. Required. - `appVersion` string — The version of the application enclosed inside of this chart. - `condition` string — The condition to check to enable chart - `dependencies` ReleaseDependency[] — Dependencies are a list of dependencies for a chart. - `alias` string — Alias usable alias to be used for the chart - `condition` string — A yaml path that resolves to a boolean, used for enabling/disabling charts (e.g. subchart1.enabled ) - `enabled` boolean — Enabled bool determines if chart should be loaded - `import-values` unknown[] — ImportValues holds the mapping of source values to parent key to be imported. Each item can be a string or pair of child/parent sublist items. - unknown - `name` string — Name is the name of the dependency. This must mach the name in the dependency's Chart.yaml. - `repository` string — The URL to the repository. Appending `index.yaml` to this string should result in a URL that can be used to fetch the repository index. - `tags` string[] — Tags can be used to group charts for enabling/disabling together - `version` string — Version is the version (range) of this chart. A lock file will always produce a single version, while a dependency may contain a semantic version range. - `deprecated` boolean — Whether or not this chart is deprecated - `description` string — A one-sentence description of the chart - `home` string — The URL to a relevant project page, git repo, or contact person - `icon` string — The URL to an icon file. - `keywords` string[] — A list of string keywords - `kubeVersion` string — KubeVersion is a SemVer constraint specifying the version of Kubernetes required. - `maintainers` ReleaseMaintainer[] — A list of name and URL/email address combinations for the maintainer(s) - `email` string — Email is an optional email address to contact the named maintainer - `name` string — Name is a user name or organization name - `url` string — URL is an optional URL to an address for the named maintainer - `name` string — The name of the chart. Required. - `sources` string[] — Source is the URL to the source code of this chart - `tags` string — The tags to check to enable chart - `type` string — Specifies the chart type: application or library - `version` string — A SemVer 2 conformant version string of the chart. Required. - `schema` integer[] — Schema is an optional JSON schema for imposing structure on Values - `templates` ReleaseFile[] — Templates for this chart. - `data` integer[] — Data is the template as byte data. - `name` string — Name is the path-like name of the template. - `values` object — Values are default config for this chart. - `chartReference` ReleaseChartReference - `chartPath` string - `registryID` integer - `repoURL` string - `config` object — Config is the set of extra Values added to the chart. These values override the default values inside of the chart. - `hooks` GithubComPortainerPortainerPkgLibhelmReleaseHook[] — Hooks are all of the hooks declared for this release. - `delete_policies` string[] — DeletePolicies are the policies that indicate when to delete the hook - `events` string[] — Events are the events that this hook fires on. - `kind` string — Kind is the Kubernetes kind. - `last_run` ReleaseHookExecution - `completed_at` string — CompletedAt indicates the date/time this hook was completed. - `phase` string — Phase indicates whether the hook completed successfully - `started_at` string — StartedAt indicates the date/time this hook was started - `manifest` string — Manifest is the manifest contents. - `name` string - `path` string — Path is the chart-relative path to the template. - `weight` integer — Weight indicates the sort order for execution among similar Hook type - `info` ReleaseInfo - `deleted` string — Deleted tracks when this object was deleted. - `description` string — Description is human-friendly "log entry" about this release. - `first_deployed` string — FirstDeployed is when the release was first deployed. - `last_deployed` string — LastDeployed is when the release was last deployed. - `notes` string — Contains the rendered templates/NOTES.txt if available - `resources` UnstructuredUnstructured[] — Resources is the list of resources that are part of the release - `Object` object — Object is a JSON compatible map with string, float, int, bool, []interface{}, or map[string]interface{} children. - `status` string — Status is the current state of the release - `manifest` string — Manifest is the string representation of the rendered template. - `name` string — Name is the name of the release - `namespace` string — Namespace is the kubernetes namespace of the release. - `stackID` integer — StackID is the ID of the Portainer stack associated with this release (if using GitOps) - `values` ReleaseValues - `computedValues` string - `userSuppliedValues` string - `version` integer — Version is an int which represents the revision of the release. ## Other responses - `400` — Invalid request payload, such as missing required fields or fields not meeting validation criteria. - `401` — Unauthorized access - the user is not authenticated or does not have the necessary permissions. Ensure that you have provided a valid API key or JWT token, and that you have the required permissions. - `403` — Permission denied - the user is authenticated but does not have the necessary permissions to access the requested resource or perform the specified operation. Check your user roles and permissions. - `404` — Unable to find an environment with the specified identifier. - `500` — Server error occurred while attempting to retrieve the release. --- [API](https://skmtc.net/portainer/apis/portainerce-api.md) · [All operations](https://skmtc.net/portainer/apis/portainerce-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/portainer/portainerce-api/versions/c0b0975cd11b/schema)