Skip to content

Register a Hyperscale instance

Request

Security
ApiKeyAuth
Bodyapplication/jsonrequired

The parameters to register a Hyperscale instance.

namestring, [ 1 .. 256 ] charactersrequired

Name in DCT of the Hyperscale instance.

hostnamestring, [ 1 .. 256 ] charactersrequired

Hostname of the Hyperscale instance.

api_keystring or null, [ 1 .. 4096 ] charactersrequired

API key to connect to the Hyperscale instance.

data_typestring(HyperscaleDataTypeEnum)required

The data type designation for the hyperscale deployment.

Enum:"ORACLE""MSSQL""DELIMITED_FILES""MONGO_DB"
Example:"ORACLE"
insecure_sslboolean

Allow connections to the hyperscale instance over HTTPs without validating the TLS certificate. Even though the connection to the hyperscale instance 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 hyperscale instance's certificate, and set the truststore_filename property.

Default:false
unsafe_ssl_hostname_checkboolean

Ignore validation of the name associated to the TLS certificate when connecting to the hyperscale instance over HTTPs. Setting this value must only be done if the TLS certificate of the hyperscale instance does not match the hostname, and the TLS configuration of the hyperscale instance 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.

Default:false
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 hyperscale instance. The truststore must be available at /etc/config/certs/<truststore_filename>

truststore_passwordstring or null, [ 1 .. 1024 ] characters

Password to read the truststore.

tagsArray of objects(Tag)

The tags to be created for this engine.

make_current_account_ownerboolean

Whether the account creating this Hyperscale instance must be configured as owner of it.

Default:true
curl -i -X POST \
  https://help-api.delphix.com/_mock/data-control-tower/continuous-compliance/23.0.0/continuous-compliance-apis-dct-23.0.0/hyperscale-instances \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "name": "string",
    "hostname": "string",
    "api_key": "string",
    "data_type": "ORACLE",
    "insecure_ssl": false,
    "unsafe_ssl_hostname_check": false,
    "truststore_filename": "string",
    "truststore_password": "string",
    "tags": [
      {
        "key": "key-1",
        "value": "value-1"
      }
    ],
    "make_current_account_owner": true
  }'

Responses

Created

Bodyapplication/json
idstringread-only

The Hyperscale instance entity ID.

namestringrequired

The name of this hyperscale instance.

hostnamestringrequired

The hostname of this hyperscale instance.

data_typestring(HyperscaleDataTypeEnum)

The data type designation for the hyperscale deployment.

Enum:"ORACLE""MSSQL""DELIMITED_FILES""MONGO_DB"
Example:"ORACLE"
creation_datestring, (date-time)

The date this hyperscale instance was registered.

tagsArray of objects(Tag)

The tags to be created for this hyperscale instance.

api_keystringrequired

API key to connect to the hyperscale instance.

insecure_sslboolean

Allow connections to the hyperscale instance over HTTPs without validating the TLS certificate. Even though the connection to the hyperscale instance 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 hyperscale instance's certificate, and set the truststore_filename property.

Default:false
unsafe_ssl_hostname_checkboolean

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

Default:false
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 hyperscale instance. 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 this hyperscale instance.

Enum:"CREATED""DELETING"
connection_statusstring or nullread-only

The status of the connection to the hyperscale instance.

Enum:"ONLINE""CONNECTION_ERROR""BAD_CREDENTIALS"
connection_status_detailsstringread-only

If set, details about the status of the connection to the hyperscale instance.

Response
{
  "id": "string",
  "name": "string",
  "hostname": "string",
  "data_type": "ORACLE",
  "creation_date": "2019-08-24T14:15:22Z",
  "tags": [
    { … }
  ],
  "api_key": "string",
  "insecure_ssl": false,
  "unsafe_ssl_hostname_check": false,
  "truststore_filename": "string",
  "truststore_password": "string",
  "status": "CREATED",
  "connection_status": "ONLINE",
  "connection_status_details": "string"
}