Check an application's Secret references (browser session)

Which Secrets the application’s workloads read without optional: true, rendered as its next deploy to this cluster namespace would render them, and whether each one will be there when they start: produced by the same deploy (its environment secrets, a Secret manifest in the set, or a CloudNativePG Cluster X publishing X-app), exists on the cluster, or missing. state is unknown when the manifests could not be rendered or the cluster’s Secrets could not be read recently enough to vouch for an absence; an unknown answer never blocks a deploy.

GET /org/applications/{application_id}/deploy/clusters/{cluster_id}/secret-references

Check an application's Secret references (browser session)

Python

import requests

url = "https://api.platform.ankra.app/org/applications/{application_id}/deploy/clusters/{cluster_id}/secret-references"

headers = {"cookie": "ankra_session="}

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

print(response.text)

200

{
  "application_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "cluster_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "namespace": "<string>",
  "state": "known",
  "reason": "<string>",
  "references": [
    {
      "name": "<string>",
      "used_by": "<string>",
      "state": "exists",
      "produced_by": "<string>"
    }
  ]
}

Authorizations

ankra_session · string · cookie · required

Browser session. Mutations also require X-Ankra-CSRF.

Path Parameters

application_id · string · required

cluster_id · string · required

Query Parameters

namespace · string · required

The Kubernetes namespace the application deploys to.

Response

200

application/json

Successful Response

application_id · string<uuid> · required

cluster_id · string<uuid> · required

namespace · string · required

state · enum<string> · required

unknown: the manifests could not be rendered or the cluster's Secrets could not be read; never block on it.

Available options: known, unknown

reason · string | null · required

references · ApplicationSecretReference · object[] · required

Show child attributes