Delphix Hyperscale Controller Service

Delphix Hyperscale Controller Service API
Version: v3.1.0
All rights reserved

Access

  1. APIKey KeyParamName:Authorization KeyInQuery:false KeyInHeader:true

Methods

[ Jump to Models ]

Table of Contents

ApiKeys

ConnectorInfo

DataSets

Engines

FileMetadata

JobExecution

Jobs

MountFileSystems

Sync

Vaults

ApiKeys

Up 
post /api-keys
Create a new API key. If no API key exists yet, or all tokens for existing API keys have been lost, the application container can be TEMPORARILY started with the API_KEY_CREATE environment variable set to string "true" and the application will create a new API key when starting and print the corresponding token to the logs. API keys created using the environment variable mechanism should only be used to boostrap the creation of other - more secure - API keys and be discarded. (createApiKey)

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body ApiKey (required)
Body Parameter —

Return type

ApiKeyToken

Example data

Content-Type: application/json
{
  "api_key_id" : 0,
  "token" : "token"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

201

Created ApiKeyToken

400

Invalid Input provided.
Up 
delete /api-keys/{apiKeyId}
Delete an API key (deleteApiKey)

Path parameters

apiKeyId (required)
Path Parameter — Numeric ID of the Api key format: int64

Responses

200

OK

404

Object Not Found.
Up 
get /api-keys/{apiKeyId}
Get an API key by id (getApiKey)

Path parameters

apiKeyId (required)
Path Parameter — Numeric ID of the Api key format: int64

Return type

ApiKey

Example data

Content-Type: application/json
{
  "name" : "name",
  "id" : 0
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK ApiKey

404

Object Not Found.
Up 
get /api-keys
Returns a list of API keys. (listApiKeys)

Return type

array[ApiKey]

Example data

Content-Type: application/json
[ {
  "name" : "name",
  "id" : 0
}, {
  "name" : "name",
  "id" : 0
} ]

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK

ConnectorInfo

Up 
post /connector-info
Create Connector Info for hyperscale compliance. (createConnectorInfo)

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body Connector-Info (required)
Body Parameter — The parameters to create a connector info.

Return type

Connector-Info

Example data

Content-Type: application/json
{
  "source" : {
    "jdbc_url" : "jdbc:oracle:thin:@:/",
    "user" : "oracle2inst1",
    "password" : "password1",
    "connection_properties" : {
      "db_key1" : "value1",
      "db_key2" : "value2"
    }
  },
  "target" : {
    "jdbc_url" : "jdbc:oracle:thin:@:/",
    "user" : "oracle2inst2",
    "password" : "password2",
    "connection_properties" : {
      "db_key1" : "value1",
      "db_key2" : "value2"
    }
  }
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

201

Created Connector-Info

400

Invalid Input provided.

500

Internal Service Unavailable.
Up 
delete /connector-info/{connectorInfoId}
Delete an existing connector info. (deleteConnectorInfo)

Path parameters

connectorInfoId (required)
Path Parameter — Numeric ID of the connector info. format: int64

Responses

200

OK

404

Object Not Found.

500

Internal Service Unavailable.
Up 
get /connector-info/{connectorInfoId}
Returns a connector info by ID. (getByConnectorInfoId)

Path parameters

connectorInfoId (required)
Path Parameter — Numeric ID of the connector info. format: int64

Return type

Connector-Info

Example data

Content-Type: application/json
{
  "source" : {
    "jdbc_url" : "jdbc:oracle:thin:@:/",
    "user" : "oracle2inst1",
    "password" : "password1",
    "connection_properties" : {
      "db_key1" : "value1",
      "db_key2" : "value2"
    }
  },
  "target" : {
    "jdbc_url" : "jdbc:oracle:thin:@:/",
    "user" : "oracle2inst2",
    "password" : "password2",
    "connection_properties" : {
      "db_key1" : "value1",
      "db_key2" : "value2"
    }
  }
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK Connector-Info

404

Object Not Found.

500

Internal Service Unavailable.
Up 
get /connector-info
Returns a list of connector info. (listAllConnectorInfo)

Return type

array[Connector-Info]

Example data

Content-Type: application/json
[ {
  "source" : {
    "jdbc_url" : "jdbc:oracle:thin:@:/",
    "user" : "oracle2inst1",
    "password" : "password1",
    "connection_properties" : {
      "db_key1" : "value1",
      "db_key2" : "value2"
    }
  },
  "target" : {
    "jdbc_url" : "jdbc:oracle:thin:@:/",
    "user" : "oracle2inst2",
    "password" : "password2",
    "connection_properties" : {
      "db_key1" : "value1",
      "db_key2" : "value2"
    }
  }
}, {
  "source" : {
    "jdbc_url" : "jdbc:oracle:thin:@:/",
    "user" : "oracle2inst1",
    "password" : "password1",
    "connection_properties" : {
      "db_key1" : "value1",
      "db_key2" : "value2"
    }
  },
  "target" : {
    "jdbc_url" : "jdbc:oracle:thin:@:/",
    "user" : "oracle2inst2",
    "password" : "password2",
    "connection_properties" : {
      "db_key1" : "value1",
      "db_key2" : "value2"
    }
  }
} ]

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK

500

Internal Service Unavailable.
Up 
put /connector-info/{connectorInfoId}
Update an existing Connector Info. (updateConnectorInfo)

Path parameters

connectorInfoId (required)
Path Parameter — Numeric ID of the connector info. format: int64

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body Connector-Info (required)
Body Parameter — The updated connector info information.

Return type

Connector-Info

Example data

Content-Type: application/json
{
  "source" : {
    "jdbc_url" : "jdbc:oracle:thin:@:/",
    "user" : "oracle2inst1",
    "password" : "password1",
    "connection_properties" : {
      "db_key1" : "value1",
      "db_key2" : "value2"
    }
  },
  "target" : {
    "jdbc_url" : "jdbc:oracle:thin:@:/",
    "user" : "oracle2inst2",
    "password" : "password2",
    "connection_properties" : {
      "db_key1" : "value1",
      "db_key2" : "value2"
    }
  }
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK Connector-Info

400

Invalid Input provided.

404

Object Not Found.

500

Internal Service Unavailable.

DataSets

Up 
post /data-sets
Create DataSet for hyperscale compliance. (createDataSet)

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body DataSet (required)
Body Parameter — The parameters to create a dataSet.

Return type

DataSet

Example data

Content-Type: application/json
{
  "connector_id" : 1,
  "mount_filesystem_id" : 1,
  "data_info" : [ {
    "source" : {
      "schema_name" : "SRC_TEST_SCHEMA_1",
      "table_name" : "SRC_TEST_TABLE_1",
      "filter_key" : "FILTER_KEY",
      "unload_split" : 4
    },
    "target" : {
      "schema_name" : "TGT_TEST_SCHEMA_1",
      "table_name" : "TGT_TEST_TABLE_1",
      "stream_size" : 65536
    },
    "masking_inventory" : [ {
      "field_name" : "user_name",
      "domain_name" : "NULL_SL",
      "algorithm_name" : "dlpx-core:FullName"
    }, {
      "field_name" : "address",
      "domain_name" : "ADDRESS",
      "algorithm_name" : "dlpx-core:CM Alpha-Numeric"
    } ]
  } ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

201

Created DataSet

400

Invalid Input provided.

500

Internal Service Unavailable.
Up 
delete /data-sets/{dataSetId}
Delete an existing dataSet. (deleteDataSet)

Path parameters

dataSetId (required)
Path Parameter — Numeric ID of the dataSet. format: int64

Responses

200

OK

404

Object Not Found.

500

Internal Service Unavailable.
Up 
get /data-sets/{dataSetId}
Returns a dataSet info by ID. (getDataSet)

Path parameters

dataSetId (required)
Path Parameter — Numeric ID of the dataSet. format: int64

Return type

DataSet

Example data

Content-Type: application/json
{
  "connector_id" : 1,
  "mount_filesystem_id" : 1,
  "data_info" : [ {
    "source" : {
      "schema_name" : "SRC_TEST_SCHEMA_1",
      "table_name" : "SRC_TEST_TABLE_1",
      "filter_key" : "FILTER_KEY",
      "unload_split" : 4
    },
    "target" : {
      "schema_name" : "TGT_TEST_SCHEMA_1",
      "table_name" : "TGT_TEST_TABLE_1",
      "stream_size" : 65536
    },
    "masking_inventory" : [ {
      "field_name" : "user_name",
      "domain_name" : "NULL_SL",
      "algorithm_name" : "dlpx-core:FullName"
    }, {
      "field_name" : "address",
      "domain_name" : "ADDRESS",
      "algorithm_name" : "dlpx-core:CM Alpha-Numeric"
    } ]
  } ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK DataSet

404

Object Not Found.

500

Internal Service Unavailable.
Up 
get /data-sets
Returns a list of dataSet. (listAllDataSet)

Return type

array[DataSet]

Example data

Content-Type: application/json
[ {
  "connector_id" : 1,
  "mount_filesystem_id" : 1,
  "data_info" : [ {
    "source" : {
      "schema_name" : "SRC_TEST_SCHEMA_1",
      "table_name" : "SRC_TEST_TABLE_1",
      "filter_key" : "FILTER_KEY",
      "unload_split" : 4
    },
    "target" : {
      "schema_name" : "TGT_TEST_SCHEMA_1",
      "table_name" : "TGT_TEST_TABLE_1",
      "stream_size" : 65536
    },
    "masking_inventory" : [ {
      "field_name" : "user_name",
      "domain_name" : "NULL_SL",
      "algorithm_name" : "dlpx-core:FullName"
    }, {
      "field_name" : "address",
      "domain_name" : "ADDRESS",
      "algorithm_name" : "dlpx-core:CM Alpha-Numeric"
    } ]
  } ]
}, {
  "connector_id" : 1,
  "mount_filesystem_id" : 1,
  "data_info" : [ {
    "source" : {
      "schema_name" : "SRC_TEST_SCHEMA_1",
      "table_name" : "SRC_TEST_TABLE_1",
      "filter_key" : "FILTER_KEY",
      "unload_split" : 4
    },
    "target" : {
      "schema_name" : "TGT_TEST_SCHEMA_1",
      "table_name" : "TGT_TEST_TABLE_1",
      "stream_size" : 65536
    },
    "masking_inventory" : [ {
      "field_name" : "user_name",
      "domain_name" : "NULL_SL",
      "algorithm_name" : "dlpx-core:FullName"
    }, {
      "field_name" : "address",
      "domain_name" : "ADDRESS",
      "algorithm_name" : "dlpx-core:CM Alpha-Numeric"
    } ]
  } ]
} ]

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK

500

Internal Service Unavailable.
Up 
put /data-sets/{dataSetId}
Update an existing DataSet. (updateDataSet)

Path parameters

dataSetId (required)
Path Parameter — Numeric ID of the dataSet. format: int64

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body DataSet (required)
Body Parameter — The updated dataset information.

Return type

DataSet

Example data

Content-Type: application/json
{
  "connector_id" : 1,
  "mount_filesystem_id" : 1,
  "data_info" : [ {
    "source" : {
      "schema_name" : "SRC_TEST_SCHEMA_1",
      "table_name" : "SRC_TEST_TABLE_1",
      "filter_key" : "FILTER_KEY",
      "unload_split" : 4
    },
    "target" : {
      "schema_name" : "TGT_TEST_SCHEMA_1",
      "table_name" : "TGT_TEST_TABLE_1",
      "stream_size" : 65536
    },
    "masking_inventory" : [ {
      "field_name" : "user_name",
      "domain_name" : "NULL_SL",
      "algorithm_name" : "dlpx-core:FullName"
    }, {
      "field_name" : "address",
      "domain_name" : "ADDRESS",
      "algorithm_name" : "dlpx-core:CM Alpha-Numeric"
    } ]
  } ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK DataSet

400

Invalid Input provided.

404

Object Not Found.

500

Internal Service Unavailable.

Engines

Up 
get /engines/{engineId}
Returns a registered engine by ID. (getRegisteredEngine)

Path parameters

engineId (required)
Path Parameter — Numeric ID of the registered engine. format: int64

Return type

RegisteredEngine

Example data

Content-Type: application/json
{
  "name" : "engine-123",
  "type" : "MASKING",
  "protocol" : "https",
  "hostname" : "eng09.dev.delphix.com",
  "username" : "user-abc",
  "password" : "abc-password",
  "ssl" : false,
  "ssl_hostname_check" : false
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK RegisteredEngine

404

Object Not Found.

500

Internal Service Unavailable.
Up 
get /engines
Returns a list of registered engines. (listRegisteredEngines)

Return type

array[RegisteredEngine]

Example data

Content-Type: application/json
[ {
  "name" : "engine-123",
  "type" : "MASKING",
  "protocol" : "https",
  "hostname" : "eng09.dev.delphix.com",
  "username" : "user-abc",
  "password" : "abc-password",
  "ssl" : false,
  "ssl_hostname_check" : false
}, {
  "name" : "engine-123",
  "type" : "MASKING",
  "protocol" : "https",
  "hostname" : "eng09.dev.delphix.com",
  "username" : "user-abc",
  "password" : "abc-password",
  "ssl" : false,
  "ssl_hostname_check" : false
} ]

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK

500

Internal Service Unavailable.
Up 
post /engines
Register an engine. (registerEngine)

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body RegisteredEngine (required)
Body Parameter — The parameters to register an engine.

Return type

RegisteredEngine

Example data

Content-Type: application/json
{
  "name" : "engine-123",
  "type" : "MASKING",
  "protocol" : "https",
  "hostname" : "eng09.dev.delphix.com",
  "username" : "user-abc",
  "password" : "abc-password",
  "ssl" : false,
  "ssl_hostname_check" : false
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

201

Created RegisteredEngine

400

Invalid Input provided.

500

Internal Service Unavailable.
Up 
delete /engines/{engineId}
Unregister an engine. (unregisterEngine)

Path parameters

engineId (required)
Path Parameter — Numeric ID of the registered engine. format: int64

Responses

200

OK

404

Object Not Found.

500

Internal Service Unavailable.
Up 
put /engines/{engineId}
Update a registered engine. (updateRegisteredEngine)

Path parameters

engineId (required)
Path Parameter — Numeric ID of the registered engine. format: int64

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body RegisteredEngine (required)
Body Parameter — The updated registration engine information.

Return type

RegisteredEngine

Example data

Content-Type: application/json
{
  "name" : "engine-123",
  "type" : "MASKING",
  "protocol" : "https",
  "hostname" : "eng09.dev.delphix.com",
  "username" : "user-abc",
  "password" : "abc-password",
  "ssl" : false,
  "ssl_hostname_check" : false
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK RegisteredEngine

400

Invalid Input provided.

404

Object Not Found.

500

Internal Service Unavailable.

FileMetadata

Up 
post /file-metadata
Create a file metadata. (createFileMetadata)

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body File-Metadata (required)
Body Parameter — The parameters to create a file metadata.

Return type

File-Metadata

Example data

Content-Type: application/json
{
  "delimiter" : ",",
  "endOfRecord" : "\n",
  "enclosure" : "'",
  "enclosureEscapeCharacter" : "'",
  "escapeEnclosureEscapeCharacter" : false,
  "built_in" : false
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

201

Created File-Metadata

400

Invalid Input provided.

500

Internal Service Unavailable.
Up 
delete /file-metadata/{fileMetadataId}
Delete an existing file metadata. (deleteFileMetadata)

Path parameters

fileMetadataId (required)
Path Parameter — Numeric ID of the file metadata. format: int64

Responses

200

OK

404

Object Not Found.

500

Internal Service Unavailable.
Up 
get /file-metadata/{fileMetadataId}
Returns a file metadata by ID. (getFileMetadataById)

Path parameters

fileMetadataId (required)
Path Parameter — Numeric ID of the file metadata. format: int64

Return type

File-Metadata

Example data

Content-Type: application/json
{
  "delimiter" : ",",
  "endOfRecord" : "\n",
  "enclosure" : "'",
  "enclosureEscapeCharacter" : "'",
  "escapeEnclosureEscapeCharacter" : false,
  "built_in" : false
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK File-Metadata

404

Object Not Found.

500

Internal Service Unavailable.
Up 
get /file-metadata
Returns a list of file metadata. (listAllFileMetadata)

Return type

array[File-Metadata]

Example data

Content-Type: application/json
[ {
  "delimiter" : ",",
  "endOfRecord" : "\n",
  "enclosure" : "'",
  "enclosureEscapeCharacter" : "'",
  "escapeEnclosureEscapeCharacter" : false,
  "built_in" : false
}, {
  "delimiter" : ",",
  "endOfRecord" : "\n",
  "enclosure" : "'",
  "enclosureEscapeCharacter" : "'",
  "escapeEnclosureEscapeCharacter" : false,
  "built_in" : false
} ]

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK

500

Internal Service Unavailable.
Up 
put /file-metadata/{fileMetadataId}
Update an existing file metadata. (updateFileMetadata)

Path parameters

fileMetadataId (required)
Path Parameter — Numeric ID of the file metadata. format: int64

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body File-Metadata (required)
Body Parameter — The updated file metadata information.

Return type

File-Metadata

Example data

Content-Type: application/json
{
  "delimiter" : ",",
  "endOfRecord" : "\n",
  "enclosure" : "'",
  "enclosureEscapeCharacter" : "'",
  "escapeEnclosureEscapeCharacter" : false,
  "built_in" : false
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK File-Metadata

400

Invalid Input provided.

404

Object Not Found.

500

Internal Service Unavailable.

JobExecution

Up 
delete /executions/{id}
Clean-up the execution by Id (cleanUpExecution)

Path parameters

id (required)
Path Parameter — Numeric ID of the Job Execution. format: int64

Responses

200

OK

404

Object Not Found.

500

Internal Service Unavailable.
Up 
post /executions
Create an execution of a Hyperscale Job. (createExecution)

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body Execution (optional)
Body Parameter —

Return type

Execution

Example data

Content-Type: application/json
{
  "job_id" : 1
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

201

Created Execution

400

Invalid Input provided.

500

Internal Service Unavailable.
Up 
get /executions/{id}
Returns the Job Execution by ID. (getExecutionById)

Path parameters

id (required)
Path Parameter — Numeric ID of the Job Execution. format: int64

Return type

Execution

Example data

Content-Type: application/json
{
  "job_id" : 1
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK Execution

404

Object Not Found.
Up 
get /executions
Returns a list of all the executions of a Hyperscale Job. (listAllExecution)

Query parameters

job_id (required)
Query Parameter — Numeric ID of the Hyperscale Job format: int64

Return type

array[Execution]

Example data

Content-Type: application/json
[ {
  "job_id" : 1
}, {
  "job_id" : 1
} ]

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK

404

Object Not Found.
Up 
put /executions/{id}/restart
Restart a failed execution. (restartExecution)

Path parameters

id (required)
Path Parameter — Numeric ID of the Job Execution. format: int64

Return type

Execution

Example data

Content-Type: application/json
{
  "job_id" : 1
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK Execution

404

Object Not Found.

500

Internal Service Unavailable.

Jobs

Up 
post /jobs
Create a Hyperscale Compliance Job. (createJob)

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body Job (required)
Body Parameter — The parameters to create a Hyperscale Compliance Job.

Return type

Job

Example data

Content-Type: application/json
{
  "name" : "job_1",
  "masking_engine_ids" : [ 1 ],
  "data_set_id" : 1,
  "app_name_prefix" : "app",
  "env_name_prefix" : "env",
  "retain_execution_data" : "NO",
  "masking_job_config" : {
    "max_memory" : 1024,
    "min_memory" : 0,
    "description" : "Job created by Hyperscale Masking",
    "feedback_size" : 100000,
    "stream_row_limit" : 10000,
    "num_input_streams" : 1
  }
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

201

Created Job

400

Invalid Input provided.

500

Internal Service Unavailable.
Up 
get /jobs/{id}
Returns a Job by ID. (getJobById)

Path parameters

id (required)
Path Parameter — Numeric ID of the Job. format: int64

Return type

Job

Example data

Content-Type: application/json
{
  "name" : "job_1",
  "masking_engine_ids" : [ 1 ],
  "data_set_id" : 1,
  "app_name_prefix" : "app",
  "env_name_prefix" : "env",
  "retain_execution_data" : "NO",
  "masking_job_config" : {
    "max_memory" : 1024,
    "min_memory" : 0,
    "description" : "Job created by Hyperscale Masking",
    "feedback_size" : 100000,
    "stream_row_limit" : 10000,
    "num_input_streams" : 1
  }
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK Job

404

Object Not Found.

500

Internal Service Unavailable.
Up 
get /jobs
Returns a list of Hyperscale Compliance Jobs. (listAllJobs)

Return type

array[Job]

Example data

Content-Type: application/json
[ {
  "name" : "job_1",
  "masking_engine_ids" : [ 1 ],
  "data_set_id" : 1,
  "app_name_prefix" : "app",
  "env_name_prefix" : "env",
  "retain_execution_data" : "NO",
  "masking_job_config" : {
    "max_memory" : 1024,
    "min_memory" : 0,
    "description" : "Job created by Hyperscale Masking",
    "feedback_size" : 100000,
    "stream_row_limit" : 10000,
    "num_input_streams" : 1
  }
}, {
  "name" : "job_1",
  "masking_engine_ids" : [ 1 ],
  "data_set_id" : 1,
  "app_name_prefix" : "app",
  "env_name_prefix" : "env",
  "retain_execution_data" : "NO",
  "masking_job_config" : {
    "max_memory" : 1024,
    "min_memory" : 0,
    "description" : "Job created by Hyperscale Masking",
    "feedback_size" : 100000,
    "stream_row_limit" : 10000,
    "num_input_streams" : 1
  }
} ]

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK

500

Internal Service Unavailable.
Up 
put /jobs/{id}
Update an existing Job. (updateJob)

Path parameters

id (required)
Path Parameter — Numeric ID of the Job. format: int64

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body Job (required)
Body Parameter — The updated Hyperscale Compliance Job information.

Return type

Job

Example data

Content-Type: application/json
{
  "name" : "job_1",
  "masking_engine_ids" : [ 1 ],
  "data_set_id" : 1,
  "app_name_prefix" : "app",
  "env_name_prefix" : "env",
  "retain_execution_data" : "NO",
  "masking_job_config" : {
    "max_memory" : 1024,
    "min_memory" : 0,
    "description" : "Job created by Hyperscale Masking",
    "feedback_size" : 100000,
    "stream_row_limit" : 10000,
    "num_input_streams" : 1
  }
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK Job

400

Invalid Input provided.

404

Object Not Found.

500

Internal Service Unavailable.

MountFileSystems

Up 
post /mount-filesystems
Create a File Mount. (createMountFilesystem)

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body MountFileSystem (required)
Body Parameter — The parameters to create a File Mount.

Return type

MountFileSystem

Example data

Content-Type: application/json
{
  "mountName" : "mount-123",
  "hostAddress" : "mount1.delphix.com",
  "mountPath" : "/var/tmp/masking-mount/",
  "mountType" : "NFS4",
  "options" : "rw"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

201

Created MountFileSystem

400

Invalid Input provided.

500

Internal Service Unavailable.
Up 
delete /mount-filesystems/{mountFileSystemId}
Delete an existing file mount. (deleteMountFilesystem)

Path parameters

mountFileSystemId (required)
Path Parameter — Numeric ID of the File Mount. format: int64

Responses

200

OK

404

Object Not Found.

500

Internal Service Unavailable.
Up 
get /mount-filesystems/{mountFileSystemId}
Returns a File Mount by ID. (getMountFilesystem)

Path parameters

mountFileSystemId (required)
Path Parameter — Numeric ID of the File Mount. format: int64

Return type

MountFileSystem

Example data

Content-Type: application/json
{
  "mountName" : "mount-123",
  "hostAddress" : "mount1.delphix.com",
  "mountPath" : "/var/tmp/masking-mount/",
  "mountType" : "NFS4",
  "options" : "rw"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK MountFileSystem

404

Object Not Found.

500

Internal Service Unavailable.
Up 
get /mount-filesystems
Returns a list of File Mounts. (listMountFilesystem)

Return type

array[MountFileSystem]

Example data

Content-Type: application/json
[ {
  "mountName" : "mount-123",
  "hostAddress" : "mount1.delphix.com",
  "mountPath" : "/var/tmp/masking-mount/",
  "mountType" : "NFS4",
  "options" : "rw"
}, {
  "mountName" : "mount-123",
  "hostAddress" : "mount1.delphix.com",
  "mountPath" : "/var/tmp/masking-mount/",
  "mountType" : "NFS4",
  "options" : "rw"
} ]

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK

500

Internal Service Unavailable.
Up 
put /mount-filesystems/{mountFileSystemId}
Update an existing File Mount. (updateMountFilesystem)

Path parameters

mountFileSystemId (required)
Path Parameter — Numeric ID of the File Mount. format: int64

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body MountFileSystem (required)
Body Parameter — The updated file mount information.

Return type

MountFileSystem

Example data

Content-Type: application/json
{
  "mountName" : "mount-123",
  "hostAddress" : "mount1.delphix.com",
  "mountPath" : "/var/tmp/masking-mount/",
  "mountType" : "NFS4",
  "options" : "rw"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK MountFileSystem

400

Invalid Input provided.

404

Object Not Found.

500

Internal Service Unavailable.
Up 
get /mount-filesystems/{mountFileSystemId}/validate
Validate the permissions for a File Mount. (validateMountFilesystem)

Path parameters

mountFileSystemId (required)
Path Parameter — Numeric ID of the File Mount. format: int64

Return type

ValidateMountFileSystemResponse

Example data

Content-Type: application/json
{
  "isValid" : true
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK ValidateMountFileSystemResponse

404

Object Not Found.

500

Internal Service Unavailable.

Sync

Up 
post /import
Import Connectors and Data Set. (importDataSet)

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body DataSetImportBundle (optional)
Body Parameter —

Request headers

Return type

DataSetImportResponse

Example data

Content-Type: application/json
{
  "data_set_id" : 1
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

201

Created DataSetImportResponse

400

Invalid Input provided.

500

Internal Service Unavailable.
Up 
post /sync-compliance-engines
Import Global Settings to sync the Compliance Engines. (importGlobalSettings)

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body GlobalSettingsImportBundle (optional)
Body Parameter —

Request headers

Return type

String

Example data

Content-Type: application/json
""

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK String

400

Invalid Input provided.

500

Internal Service Unavailable.

Vaults

Up 
post /vaults/hashicorp
Configure a new Hashicorp Vault (createHashicorpVault)

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body HashicorpVault (required)
Body Parameter —

Return type

HashicorpVaultResponse

Example data

Content-Type: application/json
{
  "env_variables" : {
    "VAULT_ADDR" : "https://vault.company.co:8200"
  },
  "id" : 0
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

201

Created HashicorpVaultResponse

400

Invalid Input provided.

500

Internal Service Unavailable.
Up 
delete /vaults/hashicorp/{vaultId}
Delete a Hashicorp vault by id (deleteHashicorpVault)

Path parameters

vaultId (required)
Path Parameter — Numeric ID of the Hashicorp vault format: int64

Responses

200

OK

404

Object Not Found.

500

Internal Service Unavailable.
Up 
get /vaults/hashicorp/{vaultId}
Get a Hashicorp vault by id (getHashicorpVault)

Path parameters

vaultId (required)
Path Parameter — Numeric ID of the Hashicorp vault format: int64

Return type

HashicorpVaultResponse

Example data

Content-Type: application/json
{
  "env_variables" : {
    "VAULT_ADDR" : "https://vault.company.co:8200"
  },
  "id" : 0
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK HashicorpVaultResponse

404

Object Not Found.

500

Internal Service Unavailable.
Up 
get /vaults/hashicorp
Returns a list of configured Hashicorp vaults. (listHashicorpVaults)

Return type

array[HashicorpVaultResponse]

Example data

Content-Type: application/json
[ {
  "env_variables" : {
    "VAULT_ADDR" : "https://vault.company.co:8200"
  },
  "id" : 0
}, {
  "env_variables" : {
    "VAULT_ADDR" : "https://vault.company.co:8200"
  },
  "id" : 0
} ]

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK

500

Internal Service Unavailable.

Models

[ Jump to Methods ]

Table of Contents

  1. ApiKey - ApiKey
  2. ApiKeyToken - ApiKeyToken
  3. Connector-Info - ConnectorInfo
  4. DataSet - DataSet
  5. DataSetImportBundle - DataSetImportBundle
  6. DataSetImportBundle_data_info_settings
  7. DataSetImportResponse - DataSetImportResponse
  8. DataSet_data_info
  9. DataSet_masking_inventory
  10. Error - Error
  11. Execution - Execution
  12. Execution_last_successful_execution
  13. Execution_tasks
  14. File-Metadata - FileMetadata
  15. GlobalSettingsImportBundle - GlobalSettingsImportBundle
  16. HashicorpVault - HashicorpVault
  17. HashicorpVaultResponse - HashicorpVaultResponse
  18. Job - Job
  19. Job_masking_job_config
  20. MountFileSystem - MountFileSystem
  21. RegisteredEngine - RegisteredEngine
  22. ValidateMountFileSystemResponse - MountFileSystemCheck

ApiKey - ApiKey Up

Information of the Authorization Key required to access the APIs.
id (optional)
Long The numeric id of the API key information. format: int64
name
String The name of the API key.

ApiKeyToken - ApiKeyToken Up

The Token to be used to access the APIs.
api_key_id (optional)
Long The numeric id of the newly created API key. format: int64
token (optional)
String The opaque token to use to authenticate for other API calls. The token must be included in all HTTP API calls in a request header named "Authorization", and prefixed with "apk " to denote that it is a proprietary API key format. For instance, if the token is "abc123", request must contain the following HTTP request header: "Authorization: apk abc123".

Connector-Info - ConnectorInfo Up

ConnectorInfo model for data source and target connection information.
id (optional)
Long The ConnectorInfo object entity ID. This field is auto-generated by the Hyperscale Compliance. format: int64
source
map[String, Object] The source used for specify connection details of the source system.
target
map[String, Object] The target used for specify connection details of the target system.

DataSet - DataSet Up

DataSet model for data source and target dataSet information.
id (optional)
Long The DataSet object entity ID. This field is auto-generated by the Hyperscale Compliance. format: int64
connector_id
Long The ID of connector-info. format: int64
mount_filesystem_id
Long The ID of MountFileSystems. format: int64
data_info
array[DataSet_data_info] The information of dataSet.

DataSetImportBundle - DataSetImportBundle Up

Bundle information to import Connectors and Data Set.
exportResponseMetadata
map[String, Object] Export metadata from Master Compliance Engine.
blob
String Export package containing data representing Compliance object.
signature
String Cryptographic signature of the blob.
publicKey
String Public version of the key used to generate the signature.
mount_filesystem_id
Long ID of the Mount FileSystem object created on Hyperscale Engine. format: int64
data_info_settings (optional)
array[DataSetImportBundle_data_info_settings] Array of additional properties to be configured for Source and Target Data Set. Each property can be configured either for SOURCE or TARGET or BOTH Data Sets.

DataSetImportBundle_data_info_settings Up

prop_key
String The key of additional property.
prop_value
String The value of additional property.
apply_to
String Defines this additional property is applicable to which Data Set, SOURCE or TARGET or BOTH.
Enum:
SOURCE
TARGET
BOTH

DataSetImportResponse - DataSetImportResponse Up

Response of Data Set Import request.
data_set_id
Long ID of the Data Set created from exported objects. format: int64

DataSet_data_info Up

source
map[String, Object] DataSet information for source, this will be key-value mapping.
target
map[String, Object] DataSet information for target, this will be key-value mapping.
masking_inventory
array[DataSet_masking_inventory] DataSet information for masking inventory, this will be array of key-value mapping.

DataSet_masking_inventory Up

field_name
String Name of the field.
domain_name
String The name of the domain assigned to this field.
algorithm_name
String The name of the algorithm assigned to this field.
date_format (optional)
String The format of the date assigned to this field. The format has to be a valid Java date format.
algorithm_field_id (optional)
Long The ID number of the algorithm field that is associated with this field. format: int64
algorithm_group_no (optional)
Long The group number of the algorithm to identify a set of columns associated with one instance of algorithm. format: int64

Error - Error Up

The Error object contains information of a failure.
message (optional)
String Message providing more detail about the error that occurred, if available.
object_name (optional)
String Name of the object affected by the error.

Execution - Execution Up

Execution information of a Hyperscale Job.
id (optional)
Long The ID number of the hyperscale masking job execution. This field is auto-generated by the Hyperscale Application. format: int64
job_id
Long The ID number of the hyperscale masking job for which the execution is created. format: int64
status (optional)
String The status of the execution regarding its completion.
Enum:
CANCELLED
FAILED
QUEUED
RUNNING
SUCCEEDED
CREATED
create_time (optional)
String The time when the execution is created.
start_time (optional)
String The time when the execution is started.
end_time (optional)
String The time when the execution is completed.
last_successful_execution (optional)
Execution_last_successful_execution
tasks (optional)
array[Execution_tasks] List of Hyperscale Tasks contained within the job execution.

Execution_last_successful_execution Up

id (optional)
Long The ID number of the last_successful_execution. format: int64
job_id (optional)
Long The ID number of the hyperscale masking job for which the execution was created. format: int64
total_time_taken (optional)
Long Total time taken in minutes to complete last_successful_execution. format: int64
masking_engine_count (optional)
Integer Total number of masking engines used in last_successful_execution.
total_distinct_source (optional)
Integer Total number of source files/tables used in last_successful_execution.

Execution_tasks Up

name
String The name of the task.
status (optional)
String The status of the task regarding its completion.
Enum:
CANCELLED
FAILED
RUNNING
SUCCEEDED
start_time (optional)
String The time when the task is started.
end_time (optional)
String The time when the task is completed.
metadata (optional)
array[Object] Data providing specific information of the task.
errors (optional)
array[Error]

File-Metadata - FileMetadata Up

FileMetadata model for file metadata related information.
id (optional)
Long The FileMetadata object entity ID. This field is auto-generated by the Hyperscale Engine. format: int64
delimiter
String The delimiter used for exporting data source to the delimited file.
endOfRecord
String The string of characters that delineates the end-of-record for a file. Note that, for linux this is \n, and for windows it is \r\n.
enclosure (optional)
String The text enclosure used for exporting data source to the delimited file.
enclosureEscapeCharacter (optional)
String The character used to escape a literal enclosure character within an enclosed value. By default, this is equal to the enclosure value itself, so doubling the enclosure character escape it.
escapeEnclosureEscapeCharacter (optional)
Boolean This flag indicates whether the enclosure escape character also escapes itself. For example, if the enclosure escape character is *, then the sequence ** would be treated as a single * character, rather than an escape.
built_in (optional)
Boolean This flag indicates whether created by customers or internal service. For example, if true, then the file metadata is created by unload service and false for the one created by customer through controller service.

GlobalSettingsImportBundle - GlobalSettingsImportBundle Up

Bundle information to import Global Settings.
exportResponseMetadata
map[String, Object] Export metadata from Master Compliance Engine.
blob
String Export package containing data representing Compliance object.
signature
String Cryptographic signature of the blob.
publicKey
String Public version of the key used to generate the signature.
compliance_engine_ids
array[Long] Array of Compliance Engine IDs on which data need to be imported. format: int64

HashicorpVault - HashicorpVault Up

Configuration required to connect and authenticate with an Hashicorp Vault which stores engines username and passwords.
id (optional)
Long format: int64
env_variables
map[String, String] Environment variables to set when invoking the Vault CLI tool. The environment variables will be used both to login to the vault (if this step is required) and to retrieve engine username and passwords.
example: {"VAULT_ADDR":"https://vault.company.co:8200","VAULT_TOKEN":"token-to-retrieve-secrets"}
login_command_args (optional)
array[String] Arguments to the "vault" CLI tool to be used to fetch a client token (or "login"). If supporting files, such as TLS certificates, must be used to authenticate, they can be mounted to the /etc/config directory. This property must not be set when using the TOKEN authentication method as login is not required.
example: ["<command>","<arg_1>","<arg_2>","<arg_n>"]

HashicorpVaultResponse - HashicorpVaultResponse Up

Configuration required to connect and authenticate with an Hashicorp Vault which stores engines username and passwords.
id
Long format: int64
env_variables
map[String, String] Environment variables to set when invoking the Vault CLI tool. The environment variables will be used both to login to the vault (if this step is required) and to retrieve engine username and passwords.
example: {"VAULT_ADDR":"https://vault.company.co:8200"}

Job - Job Up

Hyperscale Compliance Job
id (optional)
Long The ID number of the job. This field is auto-generated by the Hyperscale Compliance. format: int64
name
String Name of the Job. This should be unique.
masking_engine_ids
array[Long] Array of Masking Engine IDs. format: int64
data_set_id
Long ID of the registered Data Set model to be used for this job. format: int64
app_name_prefix
String Prefix of the name of the application to be created on masking engine. A new application with the name appNamePrefix_hyperscale will be created on masking engines.
env_name_prefix
String Prefix of the name of the environment to be created on masking engine. A new environment with the name envNamePrefix_hyperscale will be created on masking engines.
retain_execution_data (optional)
String Defines whether execution data will be stored after execution is complete. Enum having values- NO, ON_ERROR, ALWAYS.
Enum:
NO
ON_ERROR
ALWAYS
masking_job_config (optional)
Job_masking_job_config

Job_masking_job_config Up

Configuration details for the Masking Engine job. If not provided default ME job configuration will be used.
max_memory (optional)
Integer Maximum memory to be allocated for each Masking job. format: int32
min_memory (optional)
Integer Minimum memory to be allocated for each Masking job. format: int32
description (optional)
String Description of Masking job.
feedback_size (optional)
Integer Feedback Size for each Masking job. format: int32
stream_row_limit (optional)
Integer Stream Row Limit for each Masking job. format: int32
num_input_streams (optional)
Integer Number of input streams to be configured for Masking Job. format: int32

MountFileSystem - MountFileSystem Up

Mount Information.
id (optional)
Long The ID number of the mount. This field is auto-generated by the Hyperscale Engine. format: int64
mountName
String Name of the mount. This should be unique. This name will be used as a directory name by Hyperscale Engine.
hostAddress
String The host address of the server.
mountPath
String The path to the directory on the filesystem to mount.
mountType
String The type of filesystem. Enum having values- CIFS, NFS3, NFS4.
Enum:
CIFS
NFS3
NFS4
options (optional)
String The options for mount. The endpoint will return all default options and user specified options.
status (optional)
String The connection status for mount.
Enum:
ACTIVE
INACTIVE
DISCONNECTED

RegisteredEngine - RegisteredEngine Up

A registered engine's connection and authentication settings.
id (optional)
Long format: int64
name
String
type (optional)
String The type of this engine.
Enum:
VIRTUALIZATION
MASKING
protocol (optional)
String The parameter to indicate http or https communication for Masking Engine.
Enum:
http
https
hostname
String
username (optional)
String
hashicorp_vault_username_command_args (optional)
array[String] Arguments to pass to the Vault CLI tool to retrieve the username for the engine.
example: ["kv","get","-field=username","kv-v2/delphix-secrets/delphixUser"]
hashicorp_vault_id (optional)
Long Reference to the Hashicorp vault to use to retrieve engine credentials. format: int64
ssl (optional)
Boolean 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 (optional)
Boolean 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 (optional)
String 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/&lt;truststore_filename&gt;
password (optional)
String
hashicorp_vault_password_command_args (optional)
array[String] Arguments to pass to the Vault CLI tool to retrieve the password for the engine.
example: ["kv","get","-field=password","kv-v2/delphix-secrets/delphixUser"]
truststore_password (optional)
String Password to read the truststore.

ValidateMountFileSystemResponse - MountFileSystemCheck Up

Mount File system permissions validation.
isValid (optional)
Boolean The flag to validate whether a file mount is valid.
error (optional)
Error