Skip to content
/
Update a registered engin...

Update a registered engine.

Request

Security
ApiKeyAuth
Path
engineIdstringrequired

The ID of the registered engine.

Bodyapplication/jsonrequired

The updated registration engine information.

uuidstring or null

The unique identifier generated by this engine.

Example:"54290b71-58cd-463d-bd62-7219d4c4d2d5"
typestring or null

The type of this engine.

Enum:"VIRTUALIZATION""MASKING""BOTH""UNSET"
Example:"VIRTUALIZATION"
versionstring or null

The engine version.

Example:"6.0.7.0"
namestring

The name of this engine.

Example:"My Favorite Engine"
ssh_public_keystring

The ssh public key of this engine.

hostnamestring

The hostname of this engine.

Example:"eng09.dev.delphix.com"
cpu_core_countinteger or null, (int32)

The total number of CPU cores on this engine.

Example:4
memory_sizeinteger or null, (int64)

The total amount of memory on this engine, in bytes.

Example:16000000000
data_storage_capacityinteger or null, (int64)

The total amount of storage allocated for engine objects and system metadata, in bytes.

Example:100000000000
data_storage_usedinteger or null, (int64)

The amount of storage used by engine objects and system metadata, in bytes.

Example:85000000000
insecure_sslboolean

Allow connections to the engine over HTTPs without validating the TLS certificate. Even though the connection to the engine might be performed over HTTPs, setting this property eliminates the protection against a man-in-the-middle attach for connections to this engine. Instead, consider creating a truststore with a Certificate Authority to validate the engine's certificate, and set the truststore_filename property.

unsafe_ssl_hostname_checkboolean

Ignore validation of the name associated to the TLS certificate when connecting to the engine over HTTPs. Setting this value must only be done if the TLS certificate of the engine does not match the hostname, and the TLS configuration of the engine cannot be fixed. Setting this property reduces the protection against a man-in-the-middle attack for connections to this engine. This is ignored if insecure_ssl is set.

truststore_filenamestring or null, [ 1 .. 1024 ] characters^[a-zA-Z0-9_\.]+$

File name of a truststore which can be used to validate the TLS certificate of the engine. The truststore must be available at /etc/config/certs/<truststore_filename>

truststore_passwordstring or null, [ 1 .. 1024 ] characters

Password to read the truststore.

usernamestring or null, [ 1 .. 256 ] characters

The virtualization domain admin username.

passwordstring or null, [ 1 .. 4096 ] characters

The virtualization domain admin password.

masking_usernamestring or null, [ 1 .. 256 ] characters

The masking admin username.

masking_passwordstring or null, [ 1 .. 4096 ] characters

The masking admin password.

hashicorp_vault_username_command_argsArray of strings or null, [ 1 .. 100 ] items

Arguments to pass to the Vault CLI tool to retrieve the virtualization username for the engine.

Example:
[
  [
    "kv",
    "get",
    "-field=username",
    "kv-v2/delphix-secrets/delphixUser"
  ]
]
hashicorp_vault_masking_username_command_argsArray of strings or null, [ 1 .. 100 ] items

Arguments to pass to the Vault CLI tool to retrieve the masking username for the engine.

Example:
[
  [
    "kv",
    "get",
    "-field=username",
    "kv-v2/delphix-secrets/delphixUser"
  ]
]
hashicorp_vault_password_command_argsArray of strings or null, [ 1 .. 100 ] items

Arguments to pass to the Vault CLI tool to retrieve the virtualization password for the engine.

Example:
[
  [
    "kv",
    "get",
    "-field=password",
    "kv-v2/delphix-secrets/delphixUser"
  ]
]
hashicorp_vault_masking_password_command_argsArray of strings or null, [ 1 .. 100 ] items

Arguments to pass to the Vault CLI tool to retrieve the masking password for the engine.

Example:
[
  [
    "kv",
    "get",
    "-field=password",
    "kv-v2/delphix-secrets/delphixUser"
  ]
]
masking_hashicorp_vault_idinteger or null, (int64)

Reference to the Hashicorp vault to use to retrieve masking engine credentials.

hashicorp_vault_idinteger or null, (int64)

Reference to the Hashicorp vault to use to retrieve virtualization engine credentials.

tagsArray of objects(Tag)

The tags to be created for this engine.

Example:
[
  {
    "key": "key1",
    "value": "value1"
  },
  {
    "key": "key2",
    "value": "value2"
  }
]
masking_memory_usedinteger or null, (int64)

The current amount of memory used by running masking jobs in bytes.

masking_allocated_memoryinteger or null, (int64)

The maximum amount of memory available for running masking jobs in bytes.

masking_jobs_runninginteger or null

The number of masking jobs currently running.

masking_max_concurrent_jobsinteger or null

The maximum number of masking jobs that can be running at the same time.

masking_available_coresinteger or null

The number of CPU cores available to the masking engine.

hyperscale_instance_idsArray of strings or null

List of Hyperscale Instances that this engine is connected to.

Example:
[
  "hyperscale-1"
]
hyperscale_truststore_filenamestring or null, [ 1 .. 1024 ] characters^[a-zA-Z0-9_\.]+$

File name of a truststore which can be used to validate the TLS certificate of the engine as expected by associated hyperscale instances.

Example:"trustfile1"
hyperscale_truststore_passwordstring or null, [ 1 .. 1024 ] characters

Password to read the truststore as expected by associated hyperscale instances.

Example:"*****"
curl -i -X PATCH \
  'https://help-api.delphix.com/_mock/data-control-tower/continuous-data/23.0.0/continuous-data-apis-dct-23.0.0/management/engines/{engineId}' \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "id": "engine-123",
    "uuid": "54290b71-58cd-463d-bd62-7219d4c4d2d5",
    "type": "VIRTUALIZATION",
    "version": "6.0.7.0",
    "name": "My Favorite Engine",
    "hostname": "eng09.dev.delphix.com",
    "cpu_core_count": 4,
    "memory_size": 16000000000,
    "data_storage_capacity": 100000000000,
    "data_storage_used": 85000000000,
    "tags": [
      {
        "key": "key1",
        "value": "value1"
      },
      {
        "key": "key2",
        "value": "value2"
      }
    ],
    "connection_status": "OFFLINE",
    "connection_status_details": "Unable to authenticate with engine",
    "hyperscale_instance_ids": [
      "hyperscale-1"
    ],
    "hyperscale_truststore_filename": "trustfile1",
    "hyperscale_truststore_password": "*****"
  }'

Responses

OK

Bodyapplication/json
idstringread-only

The Engine object entity ID.

Example:"engine-123"
uuidstring or null

The unique identifier generated by this engine.

Example:"54290b71-58cd-463d-bd62-7219d4c4d2d5"
typestring or null

The type of this engine.

Enum:"VIRTUALIZATION""MASKING""BOTH""UNSET"
Example:"VIRTUALIZATION"
versionstring or null

The engine version.

Example:"6.0.7.0"
namestring

The name of this engine.

Example:"My Favorite Engine"
ssh_public_keystring

The ssh public key of this engine.

hostnamestring

The hostname of this engine.

Example:"eng09.dev.delphix.com"
cpu_core_countinteger or null, (int32)

The total number of CPU cores on this engine.

Example:4
memory_sizeinteger or null, (int64)

The total amount of memory on this engine, in bytes.

Example:16000000000
data_storage_capacityinteger or null, (int64)

The total amount of storage allocated for engine objects and system metadata, in bytes.

Example:100000000000
data_storage_usedinteger or null, (int64)

The amount of storage used by engine objects and system metadata, in bytes.

Example:85000000000
insecure_sslboolean

Allow connections to the engine over HTTPs without validating the TLS certificate. Even though the connection to the engine might be performed over HTTPs, setting this property eliminates the protection against a man-in-the-middle attach for connections to this engine. Instead, consider creating a truststore with a Certificate Authority to validate the engine's certificate, and set the truststore_filename property.

unsafe_ssl_hostname_checkboolean

Ignore validation of the name associated to the TLS certificate when connecting to the engine over HTTPs. Setting this value must only be done if the TLS certificate of the engine does not match the hostname, and the TLS configuration of the engine cannot be fixed. Setting this property reduces the protection against a man-in-the-middle attack for connections to this engine. This is ignored if insecure_ssl is set.

truststore_filenamestring or null, [ 1 .. 1024 ] characters^[a-zA-Z0-9_\.]+$

File name of a truststore which can be used to validate the TLS certificate of the engine. The truststore must be available at /etc/config/certs/<truststore_filename>

truststore_passwordstring or null, [ 1 .. 1024 ] characters

Password to read the truststore.

statusstring or nullread-only

the status of the engine

Enum:"CREATED""DELETING"
engine_connection_statusstringread-only

The state of the connection to the engine.

Enum:"ONLINE""CONNECTION_ERROR""MISSING_CREDENTIALS""BAD_CREDENTIALS"
engine_connection_status_detailsstringread-only

If set, details about the state of the connection to the engine.

usernamestring or null, [ 1 .. 256 ] characters

The virtualization domain admin username.

passwordstring or null, [ 1 .. 4096 ] characters

The virtualization domain admin password.

masking_usernamestring or null, [ 1 .. 256 ] characters

The masking admin username.

masking_passwordstring or null, [ 1 .. 4096 ] characters

The masking admin password.

hashicorp_vault_username_command_argsArray of strings or null, [ 1 .. 100 ] items

Arguments to pass to the Vault CLI tool to retrieve the virtualization username for the engine.

Example:
[
  [
    "kv",
    "get",
    "-field=username",
    "kv-v2/delphix-secrets/delphixUser"
  ]
]
hashicorp_vault_masking_username_command_argsArray of strings or null, [ 1 .. 100 ] items

Arguments to pass to the Vault CLI tool to retrieve the masking username for the engine.

Example:
[
  [
    "kv",
    "get",
    "-field=username",
    "kv-v2/delphix-secrets/delphixUser"
  ]
]
hashicorp_vault_password_command_argsArray of strings or null, [ 1 .. 100 ] items

Arguments to pass to the Vault CLI tool to retrieve the virtualization password for the engine.

Example:
[
  [
    "kv",
    "get",
    "-field=password",
    "kv-v2/delphix-secrets/delphixUser"
  ]
]
hashicorp_vault_masking_password_command_argsArray of strings or null, [ 1 .. 100 ] items

Arguments to pass to the Vault CLI tool to retrieve the masking password for the engine.

Example:
[
  [
    "kv",
    "get",
    "-field=password",
    "kv-v2/delphix-secrets/delphixUser"
  ]
]
masking_hashicorp_vault_idinteger or null, (int64)

Reference to the Hashicorp vault to use to retrieve masking engine credentials.

hashicorp_vault_idinteger or null, (int64)

Reference to the Hashicorp vault to use to retrieve virtualization engine credentials.

tagsArray of objects(Tag)

The tags to be created for this engine.

Example:
[
  {
    "key": "key1",
    "value": "value1"
  },
  {
    "key": "key2",
    "value": "value2"
  }
]
masking_memory_usedinteger or null, (int64)

The current amount of memory used by running masking jobs in bytes.

masking_allocated_memoryinteger or null, (int64)

The maximum amount of memory available for running masking jobs in bytes.

masking_jobs_runninginteger or null

The number of masking jobs currently running.

masking_max_concurrent_jobsinteger or null

The maximum number of masking jobs that can be running at the same time.

masking_available_coresinteger or null

The number of CPU cores available to the masking engine.

hyperscale_instance_idsArray of strings or null

List of Hyperscale Instances that this engine is connected to.

Example:
[
  "hyperscale-1"
]
hyperscale_truststore_filenamestring or null, [ 1 .. 1024 ] characters^[a-zA-Z0-9_\.]+$

File name of a truststore which can be used to validate the TLS certificate of the engine as expected by associated hyperscale instances.

Example:"trustfile1"
hyperscale_truststore_passwordstring or null, [ 1 .. 1024 ] characters

Password to read the truststore as expected by associated hyperscale instances.

Example:"*****"
connection_statusstring or nullread-onlydeprecated

The status of the connection to the engine. Deprecated; use "engine_connection_status" instead.

Enum:"ONLINE""OFFLINE"
Example:"OFFLINE"
connection_status_detailsstring or nullread-onlydeprecated

If set, details about the status of the connection to the engine. Deprecated; use "engine_connection_status_details" instead.

Example:"Unable to authenticate with engine"
Response
{
  "id": "engine-123",
  "uuid": "54290b71-58cd-463d-bd62-7219d4c4d2d5",
  "type": "VIRTUALIZATION",
  "version": "6.0.7.0",
  "name": "My Favorite Engine",
  "hostname": "eng09.dev.delphix.com",
  "cpu_core_count": 4,
  "memory_size": 16000000000,
  "data_storage_capacity": 100000000000,
  "data_storage_used": 85000000000,
  "tags": [
    { … },
    { … }
  ],
  "connection_status": "OFFLINE",
  "connection_status_details": "Unable to authenticate with engine",
  "hyperscale_instance_ids": [
    "hyperscale-1"
  ],
  "hyperscale_truststore_filename": "trustfile1",
  "hyperscale_truststore_password": "*****"
}