REST API Reference

Back Next

Delete a domain

Use a PATCH request to delete a specified domain from

IDMC

Use the following PATCH request to delete a CDI-PC domain:


PATCH /public/api/v1/domains/{ldoId}/delete

The URL paths must include the complete Domain Management Service path for the respective POD. Prefix the request with this path.

The following example demonstrates the structure and content of a typical request to delete domain API:

PATCH /public/api/v1/domains/{ldoId}/delete
Content-Type: application/json
IDS-SESSION-ID: <your-session-token>

The following table describes the header and the path parameter components:

Attribute	Type	Description
IDS-SESSION-ID	String	The IDS-SESSION-ID attribute in the header that holds the session ID value. If the organization uses the session ID authentication type, session-based authentication is used. The session ID expires after 30 minutes of inactivity. A grace period of up to 2 minutes might be included to account for any network or unexpected delays.
ldoId	String	Unique identifier assigned to a Logical Domain Object within an organization. Replace ldoId with the actual ID of the domain you want to reconcile.

The following table describes the common responses to the delete API request:

Field	Description
204	Successful deletion of domain.
400	Invalid request.
500	Internal server error when an unexpected condition is encountered.