Skip to content

Returns an environment by ID.

Request

Security
ApiKeyAuth
Path
environmentIdstring, non-emptyrequired

The ID of the environment.

curl -i -X GET \
  'https://help-api.delphix.com/_mock/data-control-tower/continuous-data/2025.2.0.0/continuous-data-apis-dct-2025.2.0.0/environments/{environmentId}' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

OK

Bodyapplication/json
idstring

The Environment object entity ID.

Example:"environment-123"
namestring

The name of this environment.

Example:"Linux Test Host"
namespace_idstring

The namespace id of this environment.

Example:"1-NAMESPACE-1"
namespace_namestring

The namespace name of this environment.

Example:"test-engine-1"
is_replicaboolean

Is this a replicated object.

Example:true
namespacestring or null

The namespace of this environment for replicated and restored objects.

Example:"NAMESPACE-1"
engine_idstring

A reference to the Engine that this Environment connection is associated with.

Example:"engine-123"
enabledboolean

True if this environment is enabled.

Example:true
encryption_enabledboolean

Flag indicating whether the data transfer is encrypted or not.

Example:false
descriptionstring

The environment description.

Example:"Windows source host"
is_clusterboolean

True if this environment is a cluster of hosts.

Example:false
cluster_homestring

Cluster home for RAC environment.

Example:"/u01/app/12.2.0.1/grid"
is_windows_targetboolean

True if this windows environment is a target environment.

Example:false
staging_environmentstring

ID of the staging environment.

Example:"1-WINDOWS_HOST-8"
hostsArray of objects(Host)

The hosts that are part of this environment.

tagsArray of objects(Tag)

The tags to be created for this environment.

repositoriesArray of objects(Repository)

Repositories associated with this environment. A Repository typically corresponds to a database installation.

listenersArray of objects(OracleListener)

Oracle listeners associated with this environment.

os_typestring

The operating system type of this environment.

Enum:"UNIX""WINDOWS"
env_usersArray of objects(EnvironmentUser)

Environment users associated with this environment.

Response
{ "id": "environment-123", "name": "Linux Test Host", "namespace_id": "1-NAMESPACE-1", "namespace_name": "test-engine-1", "is_replica": true, "namespace": "NAMESPACE-1", "engine_id": "engine-123", "enabled": true, "encryption_enabled": false, "description": "Windows source host", "is_cluster": false, "cluster_home": "/u01/app/12.2.0.1/grid", "is_windows_target": false, "staging_environment": "1-WINDOWS_HOST-8", "hosts": [ { … } ], "tags": [ { … } ], "repositories": [ { … } ], "listeners": [ { … } ], "os_type": "UNIX", "env_users": [ { … } ] }