Get a Helm release

Returns the details of one Helm release on the cluster, read live through the cluster agent. Requires kubernetes.read on the cluster; answers 404 when the release does not exist. Credential-shaped values, Secret values in the rendered manifests and credentials in the notes are withheld unless reveal_values is set and the caller holds kubernetes.secrets_reveal; secret_values says which.

GET /api/v1/clusters/{cluster_id}/kubernetes/helm/releases/{namespace}/{name}

Get a Helm release

Python

import requests

url = "https://platform.ankra.app/api/v1/clusters/{cluster_id}/kubernetes/helm/releases/{namespace}/{name}"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

200

{
  "computed_values": {},
  "hooks": [
    {}
  ],
  "manifest_resources": [
    {}
  ],
  "metadata": {
    "name": "<string>",
    "namespace": "<string>",
    "revision": 123,
    "status": "<string>",
    "app_version": "<string>",
    "chart": "<string>",
    "chart_version": "<string>",
    "description": "<string>",
    "first_deployed": "<string>",
    "last_deployed": "<string>"
  },
  "user_values": {},
  "notes": "<string>",
  "secret_values": "withheld"
}

Authorizations

Authorization · string · header · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

authorization · string | null

x-ankra-organisation-id · string | null

Path Parameters

cluster_id · string<uuid4> · required

namespace · string · required

Required string length: 1 - 253

name · string · required

Required string length: 1 - 253

Query Parameters

reveal_values · boolean · default: false

Return the release's credential-shaped values in plaintext. Needs kubernetes.secrets_reveal on the cluster and writes one audit row; without the permission the values stay withheld and secret_values is permission_required.

Response

200

application/json

Successful Response

computed_values · Computed Values · object · required

hooks · Hooks · object[] · required

manifest_resources · Manifest Resources · object[] · required

metadata · HelmReleaseMetadata · object · required

Show child attributes

user_values · User Values · object · required

notes · string | null

secret_values · enum<string>

Set only when the release carries credential-shaped values. withheld: credential leaves of user_values and computed_values (by key name or by secret pattern), every Secret value in manifest_resources and hooks, and credentials detected in notes are replaced by [REDACTED:...] placeholders. permission_required: reveal_values was set without kubernetes.secrets_reveal. revealed: the values are plaintext and the reveal is audited. unavailable: a reveal was allowed but the audit row could not be written, so the values stay withheld.

Available options: withheld, permission_required, revealed, unavailable