domains

Delete a domain

Delete a domain with type "managed" by its ID

delete/domains/{id}

Request

  • Base URL
    https://api.didomi.io (the document declares no server; this is the origin it was published from)
  • URL
    https://api.didomi.io/domains/{id}
  • Auth
    HTTP bearer

Path parameters

idstring required

The ID of the domain to delete

Response

A Domain object

idstring

Fully qualified domain name

organization_idstring

The ID of the organization that owns this data processing

descriptionstring

Description of the domain name usage in your organization

enabledboolean

Whether the domain is enabled or not. Disabling a domain triggers de-provisioning of the domain on the Didomi platform which might break existing notices or privacy centers if the domain is still in use. Make sure that the domain is not used anymore before disabling it.

entity_idstring

Which entity the domain is used by. This entity ID is currently used by PMP for the domain to properly redirect to the correct S3 bucket (preference-center/organization_id/entity_id/)

typestring

Type of the domain. "custom" indicates a domain owned and delegated by a client while "managed" indicates a domain that Didomi owns and manages like "privacy-center.org". This is automatically set when a domain is created

statusstring

Provisioning status on the Didomi platform. Possible values: draft (domain is created but not deployed yet), scheduled (domain is scheduled for deployment), to_be_deleted (domain is scheduled for deletion), deploying (domain is being provisioned), deleting (domain is being deleted), failed (domain deployment/deletion failed), ready (domain is provisioned and ready for use)

usagestring

What the domain is used for: CMP ("cmp"), Privacy Center ("privacy-center"), Preference Center ("preference-center")

bots_crawl'allow_all' | 'disallow_all'

Controls whether bots are allowed to crawl the domain. Possible values: "allow_all" (allow crawls from any bots) or "disallow_all" (disallow crawls from all bots)

created_atstring date-time

Creation date of the domain

updated_atstring date-time

Last update date of the domain

versionnumber

Revision number of the domain entity

Changes

No recorded changes to this operation across all 10 revisions of this API.