REST API Reference > Cloud Data Integration for PowerCenter (CDI-PC) REST API > Deregistering a domain
  

Deregistering a domain

Use a PATCH request to deregister a CDI-PC domain from IDMC.

PATCH request

Use the following PATCH request to deregister a CDI-PC domain:
PATCH /public/api/v1/domains/{ldoId}/deregister
Note: The URL paths must include the complete Domain Management Service path for the respective POD. Prefix the request with this path.

Parameters

To deregister a CDI-PC domain in IDMC using the REST API, provide a request with specific parameters that detail the domain's configuration and authentication credentials.
The following example demonstrates the structure and content of a typical request to deregister domain API:
PATCH /public/api/v1/domains/{ldoId}/deregister
Content-Type: application/json
Accept: */*
IDS-SESSION-ID: <your-session-token>

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

{
"domainAuthInfo": {
"username": "admin",
"password": "secretPassword",
"namespace": "Native"
}
The following table describes the parameters of the header component:
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.

Request body

The request body requires a domainAuthInfo object for authentication purposes.

{ "domainAuthInfo": {
"username": "string",
"password": "string",
"namespace": "string"
}
}
The following table describes the fields of domainAuthInfo:
Field
Type
Description
username
String
The username for authenticating access to a specific domain. It identifies the user within the domain's authentication system.
password
String
The corresponding password for the username.
namespace
String
The namespace associated with the domain authentication.

Responses

The following table describes the common responses to the deregister API request:
Field
Description
Sample example
200
Success response.
{
"message": "string"
}
400
Bad request. Can be a field or format issue, such as an invalid character or incorrect string length.
{
"result": {
"output": {
"status": "string",
"message": "string",
"data": {}
},
"errorInfo": {
"error": {
"code": "string",
"message": "string",
"debugMessage": "string",
"requestId": "string",
"details": [
{
"code": "string",
"message": "string",
"debugMessage": "string"
}
],
"errorContext": {
"component": "string",
"componentId": "string",
"sanitizedLogDirectoryPaths": [
"string"
]
}
}
}
}
401
Authentication issue. For example, invalid credentials or invalid session IDs.
For invalid credentials or invalid session ID, you might see responses,such as Exception encountered while processing JWT or Unauthorized request error.
500
Internal server error when an unexpected condition is encountered.
{
"result": {
"output": {
"status": "string",
"message": "string",
"data": {}
},
"errorInfo": {
"error": {
"code": "string",
"message": "string",
"debugMessage": "string",
"requestId": "string",
"details": [
{
"code": "string",
"message": "string",
"debugMessage": "string"
}
],
"errorContext": {
"component": "string",
"componentId": "string",
"sanitizedLogDirectoryPaths": [
"string"
]
}
}
}
}