Skip to main content
Privacy Dashboard

Deploy privacy dashboard

POST/v4/config/platform/privacy-dashboard

Deploys the privacy dashboard of the organisation: the web app where your individuals see and change their consent. Upload the logo of the organisation first, and pick a version from List privacy dashboard releases. The hostname must be a host name under igrant.io (not www.igrant.io) that no other organisation uses.

The service creates the deployment in the cluster during the call and answers when it is done. To change the host name or the release of a deployed privacy dashboard, or to repair it, use Reconfigure privacy dashboard.

Authorizations

  • Authorizationstringheaderrequired

    Your API key with the prefix ApiKey: ApiKey <your-api-key>. Get an API key.

    Scope:privacy-dashboard:create

Body

application/json
  • hostnamestringrequired

    Host name of the privacy dashboard, for example acme-privacy.igrant.io.

    Example:"acme-privacy.igrant.io"

  • versionstringrequired

    Release to deploy (a version of List privacy dashboard releases).

    Example:"v2026.10.1"

Response

application/json

The deployed privacy dashboard (status 2).

  • hostnamestring

    Host name of the privacy dashboard, for example acme-privacy.igrant.io. Empty when not deployed.

    Example:"acme-privacy.igrant.io"

  • versionstring

    Release of the privacy dashboard (a version of List privacy dashboard releases). Empty when not deployed.

    Example:"v2026.10.1"

  • statusenum<integer>

    Status of the deployment: 0 not configured, 1 requested (a deployment started and did not complete), 2 deployed.

    Available options:0,1,2

    Example:2

  • statusStrenum<string>

    Label of status.

    Available options:Not Configured,Requested,Deployed

    Example:"Deployed"