Privacy Dashboard

Reconfigure privacy dashboard

POST/v4/config/platform/privacy-dashboard/reconfigure

Brings the privacy dashboard deployment in the cluster in line with the record, and restarts it so that it reads its configuration again. Use it to repair a deployment, to complete a deployment that stopped half-way (status 1), to change the host name or to change the release. The privacy dashboard must be deployed or requested.

The body is optional. A hostname or version that you send replaces the recorded value; a member that you do not send, or send empty, keeps it. A new host name must be valid and not used by another organisation, and the version must be a release of List privacy dashboard releases. The response is the deployment status after the change.

Language of the request sample

curl -X POST 'https://demo-api.igrant.io/v4/config/platform/privacy-dashboard/reconfigure' \
  -H 'Authorization: ApiKey <your-api-key>' \
  -H 'Content-Type: application/json' \
  -d '{
  "version": "v2026.10.2"
}'

{
  "hostname": "acme-privacy.igrant.io",
  "version": "v2026.10.2",
  "status": 2,
  "statusStr": "Deployed",
  "state": "progressing",
  "problems": [
    "The rollout is in progress: 0 of 1 replicas ready."
  ],
  "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.2-release",
      "version": "v2026.10.2",
      "desiredReplicas": 1,
      "updatedReplicas": 0,
      "readyReplicas": 0,
      "availableReplicas": 0,
      "conditions": []
    },
    "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:update

Body

application/json

hostnamestring
New host name of the privacy dashboard, under igrant.io.
Example:"acme-consent.igrant.io"
versionstring
New release (a version of List privacy dashboard releases).
Example:"v2026.10.2"

Response

application/json

The deployment status after the change.

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"