Delphix Hyperscale Controller Service (v4.1.0)

Download OpenAPI specification:Download

URL: https://support.delphix.com

Delphix Hyperscale Controller Service API

Engines

Register an engine.

SecurityApiKeyAuth
Request
Request Body schema: application/json
required

The parameters to register an engine.

name
required
string [ 1 .. 256 ] characters
type
string

The type of this engine.

Enum: "VIRTUALIZATION" "MASKING"
protocol
string

The parameter to indicate http or https communication for Masking Engine.

Enum: "http" "https"
hostname
required
string [ 1 .. 256 ] characters
username
string or null [ 1 .. 256 ] characters
hashicorp_vault_username_command_args
Array of strings or null [ 1 .. 100 ] items

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

hashicorp_vault_id
integer or null <int64>

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

ssl
boolean or null

Allow connections to the engine over HTTPs with or without validating the TLS certificate. Even though the connection to the engine might be performed over HTTPs, setting this property false eliminates the protection against a man-in-the-middle attack for connections to this engine. Instead, consider creating a truststore with a Certificate Authority to validate the engine's certificate, and set the truststore_path property. If no value of ssl is provided when protocol is HTTPS, value will be set to true.

ssl_hostname_check
boolean or null

Ignore validation of the name associated to the TLS certificate when connecting to the engine over HTTPs. Setting this value false 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 ssl flag is set to false. If no value of ssl_hostname_check is provided when protocol is HTTPS, value will be set to true.

truststore_filename
string 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/cert/

password
string or null [ 1 .. 4096 ] characters
hashicorp_vault_password_command_args
Array of strings or null [ 1 .. 100 ] items

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

truststore_password
string or null [ 1 .. 1024 ] characters

Password to read the truststore.

Responses
201

Created

400

Invalid Input provided.

500

Internal Service Unavailable.

post/engines
Request samples
application/json
{
  • "name": "engine-123",
  • "type": "MASKING",
  • "protocol": "http",
  • "hostname": "eng09.dev.delphix.com",
  • "username": "user-abc",
  • "password": "abc-password"
}
Response samples
application/json
{
  • "name": "engine-123",
  • "type": "MASKING",
  • "protocol": "http",
  • "hostname": "eng09.dev.delphix.com",
  • "username": "user-abc",
  • "password": "abc-password"
}

Returns a list of registered engines.

SecurityApiKeyAuth
Responses
200

OK

500

Internal Service Unavailable.

get/engines
Response samples
application/json
{
  • "name": "engine-123",
  • "type": "MASKING",
  • "protocol": "http",
  • "hostname": "eng09.dev.delphix.com",
  • "username": "user-abc",
  • "password": "abc-password"
}

Returns a registered engine by ID.

SecurityApiKeyAuth
Request
path Parameters
engineId
required
integer <int64> >= 1

Numeric ID of the registered engine.

Responses
200

OK

404

Object Not Found.

500

Internal Service Unavailable.

get/engines/{engineId}
Response samples
application/json
{
  • "name": "engine-123",
  • "type": "MASKING",
  • "protocol": "http",
  • "hostname": "eng09.dev.delphix.com",
  • "username": "user-abc",
  • "password": "abc-password"
}

Update a registered engine.

SecurityApiKeyAuth
Request
path Parameters
engineId
required
integer <int64> >= 1

Numeric ID of the registered engine.

Request Body schema: application/json
required

The updated registration engine information.

name
required
string [ 1 .. 256 ] characters
type
string

The type of this engine.

Enum: "VIRTUALIZATION" "MASKING"
protocol
string

The parameter to indicate http or https communication for Masking Engine.

Enum: "http" "https"
hostname
required
string [ 1 .. 256 ] characters
username
string or null [ 1 .. 256 ] characters
hashicorp_vault_username_command_args
Array of strings or null [ 1 .. 100 ] items

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

hashicorp_vault_id
integer or null <int64>

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

ssl
boolean or null

Allow connections to the engine over HTTPs with or without validating the TLS certificate. Even though the connection to the engine might be performed over HTTPs, setting this property false eliminates the protection against a man-in-the-middle attack for connections to this engine. Instead, consider creating a truststore with a Certificate Authority to validate the engine's certificate, and set the truststore_path property. If no value of ssl is provided when protocol is HTTPS, value will be set to true.

ssl_hostname_check
boolean or null

Ignore validation of the name associated to the TLS certificate when connecting to the engine over HTTPs. Setting this value false 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 ssl flag is set to false. If no value of ssl_hostname_check is provided when protocol is HTTPS, value will be set to true.

truststore_filename
string 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/cert/

password
string or null [ 1 .. 4096 ] characters
hashicorp_vault_password_command_args
Array of strings or null [ 1 .. 100 ] items

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

truststore_password
string or null [ 1 .. 1024 ] characters

Password to read the truststore.

Responses
200

OK

400

Invalid Input provided.

404

Object Not Found.

500

Internal Service Unavailable.

put/engines/{engineId}
Request samples
application/json
{
  • "name": "engine-123",
  • "type": "MASKING",
  • "protocol": "http",
  • "hostname": "eng09.dev.delphix.com",
  • "username": "user-abc",
  • "password": "abc-password"
}
Response samples
application/json
{
  • "name": "engine-123",
  • "type": "MASKING",
  • "protocol": "http",
  • "hostname": "eng09.dev.delphix.com",
  • "username": "user-abc",
  • "password": "abc-password"
}

Unregister an engine.

SecurityApiKeyAuth
Request
path Parameters
engineId
required
integer <int64> >= 1

Numeric ID of the registered engine.

Responses
200

OK

404

Object Not Found.

500

Internal Service Unavailable.

delete/engines/{engineId}
➔ Next to Vaults