Privacy Dashboard

Read privacy dashboard deployment status

GET/v4/config/platform/privacy-dashboard/deployment-status

Compares the privacy dashboard record of the organisation with its deployment in the cluster, and returns the state and the problems found. This call only reads: to repair a deployment, use Reconfigure privacy dashboard. When the service cannot read the cluster, the response is still 200, with the state unknown.

Language of the request sample

curl 'https://demo-api.igrant.io/v4/config/platform/privacy-dashboard/deployment-status' \
  -H 'Authorization: ApiKey <your-api-key>'

{
  "hostname": "acme-privacy.igrant.io",
  "version": "v2026.10.1",
  "status": 2,
  "statusStr": "Deployed",
  "state": "running",
  "problems": [],
  "kubernetes": {
    "namespace": "release",
    "configMap": {
      "name": "org-6ae2bf741c3dadfeb27982ec-privacy-config",
      "exists": true
    },
    "service": {
      "name": "org-6ae2bf741c3dadfeb27982ec-privacy-svc",
      "exists": true
    },
    "deployment": {
      "name": "org-6ae2bf741c3dadfeb27982ec-privacy-app",
      "exists": true,
      "image": "eu.gcr.io/example-project/privacy-dashboard:privacy-dashboard-v2026.10.1-release",
      "version": "v2026.10.1",
      "desiredReplicas": 1,
      "updatedReplicas": 1,
      "readyReplicas": 1,
      "availableReplicas": 1,
      "conditions": [
        {
          "type": "Available",
          "status": "True",
          "reason": "MinimumReplicasAvailable",
          "message": "Deployment has minimum availability."
        },
        {
          "type": "Progressing",
          "status": "True",
          "reason": "NewReplicaSetAvailable",
          "message": "ReplicaSet \"org-6ae2bf741c3dadfeb27982ec-privacy-app-5d9c7b6f8d\" has successfully progressed."
        }
      ]
    },
    "ingress": {
      "name": "org-6ae2bf741c3dadfeb27982ec-privacy-ing",
      "exists": true,
      "hosts": [
        "acme-privacy.igrant.io"
      ],
      "hostnameMatches": true,
      "tlsSecretName": "igrant-io-tls"
    }
  },
  "checkedAt": "2026-11-05T09:30:00Z"
}

Authorizations

Authorizationstringheaderrequired
Your API key with the prefix ApiKey: ApiKey <your-api-key>. Get an API key.
Scope:privacy-dashboard:read

Response

application/json

The deployment status.

hostnamestring
Recorded host name of the privacy dashboard. Empty when not deployed.
Example:"acme-privacy.igrant.io"
versionstring
Recorded release of the privacy dashboard. Empty when not deployed.
Example:"v2026.10.1"
statusenum<integer>
Recorded status: 0 not configured, 1 requested, 2 deployed.
Available options:0,1,2
Example:2
statusStrenum<string>
Label of status.
Available options:Not Configured,Requested,Deployed
Example:"Deployed"
stateenum<string>
The state of the deployment in the cluster: not_configured (no deployment is recorded), running (all objects exist, match the record and all replicas are ready), requested (all objects exist, but the record is still requested), progressing (a rollout is in progress), degraded (no ready replica, or the rollout failed), missing (one or more objects do not exist), drift (the image version or the ingress host differs from the record) or unknown (the service cannot read the cluster). The first that applies of missing, drift, degraded, progressing, requested and running is the state.
Available options:not_configured,requested,running,progressing,degraded,missing,drift,unknown
Example:"running"
problemsstring[]
The problems found, as sentences. Empty when there is none.
kubernetesobject
The objects of the deployment in the cluster. Not present for not_configured and unknown.
checkedAtstring<date-time>
Time of the check (UTC).
Example:"2026-11-05T09:30:00Z"