REST API Reference > PowerCenter Modernization REST API > Get domains
  

Get domains

Retrieves a list of domains.

API request

To retrieve a list of domains, send a GET request to the following API:
GET <pod_base_url>/dms/api/v1/domains

Request parameters

Path parameters
No parameter.
Query parameters
The following table describes the query parameters that you specify in the API request:
Name
Type
Required or Optional
Description
sort
String
Optional
Field and direction used to order the returned domain list. Value format is {fieldName},{direction}. Allowed values for direction: asc and desc.
Default value is createdTime,asc. By default, the returned domains are sorted by createdTime in ascending order.
Body Parameters
No parameter.

Request headers

The following table describes the headers that you specify in the API request:
Name
Required or Optional
Description
IDS-SESSION-ID
Required
Session token to authenticate the request.

Response parameters

The following table describes the parameters that are returned by the API:
Name
Type
Description
domains
Array
Array of domain objects returned by the request, sorted by createdTime in ascending order.
domains.ldoId
String
Unique identifier for the local domain object associated with this domain.
domains.pdoId
String
Unique identifier for the physical domain object associated with the domain entry. pdoId value is null when the domain has not been registered.
domains.createdBy
String
Unique identifier of the user who created the domain.
domains.createdByUserName
String
Username of the user who created the domain.
domains.createdTime
Integer
Unix epoch timestamp in milliseconds indicating when the domain was created.
domains.updatedByUserName
String
Username of the user who last updated the domain record.
domains.updatedTime
Integer
Unix epoch timestamp in milliseconds indicating when the domain was last updated.
domains.orgId
String
Unique identifier for the organization associated with the domain.
domains.isRegistered
Boolean
Indicates whether the domain has been registered.
domains.pdoState
String
Availability state of the registered domain.
domains.kerberos
Boolean
Indicates whether Kerberos authentication is enabled for the domain.
domains.pdoIndicator
String
Operational status indicator for the domain.
domains.registrationState
String
Registration state of the domain.
domains.domainStatus
String
Details of the nodes and services that are available in the domain.
domains.updateAvailable
Boolean
Indicates whether an update is available for the domain.
domains.domainName
String
Name of the domain.
domains.domainDisplayName
String
Display name of the domain.
domains.domainHost
String
Hostname or IP address of the server where the domain is deployed.
domains.domainPort
Integer
Port number on which the domain service listens for incoming connections.
domains.description
String
Description of the domain.
domains.environmentType
String
Type of the domain's deployment environment.
domains.secureAgentGroup
Object
Object containing the secure agent group associated with the domain, identified by its SaaS agent group ID.
domains.domainSecurityInfo
Object
Authentication credentials used to connect to the domain, including the username and security namespace.
domains.registered
Boolean
Indicates whether the domain is registered with the organization.

Sample request

The following is a sample request based on the values provided:

curl -X GET \
"{pod_base_url}/dms/api/v1/domains?sort=createdTime,asc" \
-H "IDS-SESSION-ID: eyJraW********"

Sample response

200 OK
{
"domains": [
{
"ldoId": "0M0BRzxLmEsfrkjbI3rIoi",
"pdoId": null,
"createdBy": "aAMp82ldq24j5x0tgG3cEd",
"createdByUserName": "wb_rel",
"createdTime": 1752811144598,
"updatedByUserName": null,
"updatedTime": 1752811292795,
"orgId": null,
"isRegistered": false,
"pdoState": null,
"kerberos": false,
"pdoIndicator": null,
"registrationState": "UNREGISTERED",
"domainStatus": null,
"updateAvailable": false,
"domainName": "DOMAIN_1",
"domainDisplayName": "xxxx1902_DOMAIN_1",
"domainHost": "xxxx1902.informatica.com",
"domainPort": 11000,
"description": "",
"environmentType": "NONE",
"secureAgentGroup": {
"agentGroupSaasId": "016JN325000000000006"
},
"domainSecurityInfo": {
"username": "Administrator",
"namespace": "Native"
},
"registered": false
}]}