Update an environment by ID.

Request

Security

ApiKeyAuth

Path

environmentIdstring, non-emptyrequired

The ID of the environment.

Bodyapplication/json

the parameters to update an environment

namestring, [ 1 .. 256 ] characters

The name of the environment.

Example:"oracle-environment"

staging_environmentstring, [ 1 .. 256 ] characters

Id of the connector environment which is used to connect to this source environment.

Example:"1-WINDOWS_HOST-1"

cluster_addressstring, [ 1 .. 256 ] characters

Address of the cluster. This property can be modified for Windows cluster only.

Example:"db.host.com"

cluster_homestring, [ 1 .. 256 ] characters

Absolute path to cluster home directory. This parameter is for UNIX cluster environments.

Example:"/u01/app/19.0.0.0/grid"

ase_db_usernamestring, [ 1 .. 256 ] characters

username of the SAP ASE database.

Example:"user-123"

ase_db_passwordstring, [ 1 .. 256 ] characters

password of the SAP ASE database.

Example:"test"

ase_db_vaultstring, [ 1 .. 256 ] characters

The name or reference of the vault from which to read the ASE database credentials.

Example:"my-vault"

ase_db_vault_usernamestring, [ 1 .. 256 ] characters

Delphix display name for the vault user

Example:"user-123"

ase_db_hashicorp_vault_enginestring, [ 1 .. 256 ] characters

Vault engine name where the credential is stored.

Example:"kv"

ase_db_hashicorp_vault_secret_pathstring, [ 1 .. 256 ] characters

Path in the vault engine where the credential is stored.

Example:"oracle-env"

ase_db_hashicorp_vault_username_keystring, [ 1 .. 256 ] characters

Key for the username in the key-value store.

Example:"username"

ase_db_hashicorp_vault_secret_keystring, [ 1 .. 256 ] characters

Key for the password in the key-value store.

Example:"secret"

ase_db_cyberark_vault_query_stringstring, [ 1 .. 256 ] characters

Query to find a credential in the CyberArk vault.

Example:"Safe=Test;Folder=Test;Object=Test"

ase_db_azure_vault_namestring, [ 1 .. 256 ] characters

Azure key vault name.

Example:"azure_vault"

ase_db_azure_vault_username_keystring, [ 1 .. 256 ] characters

Azure vault key for the username in the key-value store.

Example:"username"

ase_db_azure_vault_secret_keystring, [ 1 .. 256 ] characters

Azure vault key for the password in the key-value store.

Example:"secret"

ase_db_use_kerberos_authenticationboolean

Whether to use kerberos authentication for ASE DB discovery.

Example:true

descriptionstring, [ 1 .. 1024 ] characters

The environment description.

Example:"Unix Orcale source host"

The request example is intended for updating Unix standalone environments.

curl -i -X PATCH \
  'https://help-api.delphix.com/_mock/data-control-tower/continuous-data/22.0.0/continuous-data-apis-dct-22.0.0/environments/{environmentId}' \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "name": "oracle-environment",
    "ase_db_username": "user-123",
    "ase_db_password": "test",
    "ase_db_vault": "my-vault",
    "ase_db_hashicorp_vault_engine": "kv",
    "ase_db_hashicorp_vault_secret_path": "ase-env",
    "ase_db_hashicorp_vault_username_key": "username",
    "ase_db_hashicorp_vault_secret_key": "password",
    "ase_db_cyberark_vault_query_string": "Safe=Test;Folder=Test;Object=Test",
    "ase_db_use_kerberos_authentication": true,
    "description": "Unix Oracle source host"
  }'

Responses

Bodyapplication/json

jobobject(Job)

An asynchronous task.

Response

{
  "job": {
    "id": "job-123",
    "status": "RUNNING",
    "is_waiting_for_telemetry": true,
    "type": "DB_REFRESH",
    "localized_type": "DB Refresh",
    "error_details": "Unable to connect to the engine.",
    "warning_message": "Failed to remove local MaskingJob, engineId: 3 localMaskingJobId: 7.",
    "target_id": "vdb-123",
    "target_name": "vdb",
    "start_time": "2022-01-02T05:11:24.148Z",
    "update_time": "2022-01-02T06:11:24.148Z",
    "trace_id": "string",
    "engine_ids": [ … ],
    "tags": [ … ],
    "engines": [ … ],
    "account_id": 1,
    "account_name": "User 1",
    "percent_complete": 50,
    "virtualization_tasks": [ … ],
    "tasks": [ … ],
    "execution_id": "string"
  }
}