# Delphix Hyperscale Controller Service Delphix Hyperscale Controller Service API Version: v4.0.0 ## Servers ``` /api/v4.0.0 ``` ## Security ### ApiKeyAuth Type: apiKey In: header Name: Authorization ## Download OpenAPI description [Delphix Hyperscale Controller Service](https://help-api.delphix.com/_bundle/Hyperscale%20Compliance/27.0.0/Hyperscale%20Compliance%20APIs%20(27.0.0).yaml) ## Engines ### Register an engine. - [POST /engines](https://help-api.delphix.com/hyperscale-compliance/27.0.0/hyperscale-compliance-apis-27.0.0/engines/register_engine.md) ### Returns a list of registered engines. - [GET /engines](https://help-api.delphix.com/hyperscale-compliance/27.0.0/hyperscale-compliance-apis-27.0.0/engines/list_registered_engines.md) ### Returns a registered engine by ID. - [GET /engines/{engineId}](https://help-api.delphix.com/hyperscale-compliance/27.0.0/hyperscale-compliance-apis-27.0.0/engines/get_registered_engine.md) ### Update a registered engine. - [PUT /engines/{engineId}](https://help-api.delphix.com/hyperscale-compliance/27.0.0/hyperscale-compliance-apis-27.0.0/engines/update_registered_engine.md) ### Unregister an engine. - [DELETE /engines/{engineId}](https://help-api.delphix.com/hyperscale-compliance/27.0.0/hyperscale-compliance-apis-27.0.0/engines/unregister_engine.md) ## Vaults ### Returns a list of configured Hashicorp vaults. - [GET /vaults/hashicorp](https://help-api.delphix.com/hyperscale-compliance/27.0.0/hyperscale-compliance-apis-27.0.0/vaults/list_hashicorp_vaults.md) ### Configure a new Hashicorp Vault - [POST /vaults/hashicorp](https://help-api.delphix.com/hyperscale-compliance/27.0.0/hyperscale-compliance-apis-27.0.0/vaults/create_hashicorp_vault.md) ### Get a Hashicorp vault by id - [GET /vaults/hashicorp/{vaultId}](https://help-api.delphix.com/hyperscale-compliance/27.0.0/hyperscale-compliance-apis-27.0.0/vaults/get_hashicorp_vault.md) ### Delete a Hashicorp vault by id - [DELETE /vaults/hashicorp/{vaultId}](https://help-api.delphix.com/hyperscale-compliance/27.0.0/hyperscale-compliance-apis-27.0.0/vaults/delete_hashicorp_vault.md) ## MountFileSystem ### Returns the configured Mount File System. - [GET /mount-filesystem](https://help-api.delphix.com/hyperscale-compliance/27.0.0/hyperscale-compliance-apis-27.0.0/mountfilesystem/get_mount_filesystem.md) ### Validate the permissions for the File Mount. - [GET /mount-filesystem/validate](https://help-api.delphix.com/hyperscale-compliance/27.0.0/hyperscale-compliance-apis-27.0.0/mountfilesystem/validate_mount_filesystem.md) ## ConnectorInfo ### Create Connector Info for hyperscale compliance. - [POST /connector-info](https://help-api.delphix.com/hyperscale-compliance/27.0.0/hyperscale-compliance-apis-27.0.0/connectorinfo/create_connector_info.md) ### Returns a list of connector info. - [GET /connector-info](https://help-api.delphix.com/hyperscale-compliance/27.0.0/hyperscale-compliance-apis-27.0.0/connectorinfo/list_all_connector_info.md) ### Returns a connector info by ID. - [GET /connector-info/{connectorInfoId}](https://help-api.delphix.com/hyperscale-compliance/27.0.0/hyperscale-compliance-apis-27.0.0/connectorinfo/get_by_connectorinfoid.md) ### Update an existing Connector Info. - [PUT /connector-info/{connectorInfoId}](https://help-api.delphix.com/hyperscale-compliance/27.0.0/hyperscale-compliance-apis-27.0.0/connectorinfo/update_connector_info.md) ### Delete an existing connector info. - [DELETE /connector-info/{connectorInfoId}](https://help-api.delphix.com/hyperscale-compliance/27.0.0/hyperscale-compliance-apis-27.0.0/connectorinfo/delete_connector_info.md) ## FileMetadata ### Create a file metadata. - [POST /file-metadata](https://help-api.delphix.com/hyperscale-compliance/27.0.0/hyperscale-compliance-apis-27.0.0/filemetadata/create_file_metadata.md) ### Returns a list of file metadata. - [GET /file-metadata](https://help-api.delphix.com/hyperscale-compliance/27.0.0/hyperscale-compliance-apis-27.0.0/filemetadata/list_all_file_metadata.md) ### Returns a file metadata by ID. - [GET /file-metadata/{fileMetadataId}](https://help-api.delphix.com/hyperscale-compliance/27.0.0/hyperscale-compliance-apis-27.0.0/filemetadata/get_file_metadata_by_id.md) ### Update an existing file metadata. - [PUT /file-metadata/{fileMetadataId}](https://help-api.delphix.com/hyperscale-compliance/27.0.0/hyperscale-compliance-apis-27.0.0/filemetadata/update_file_metadata.md) ### Delete an existing file metadata. - [DELETE /file-metadata/{fileMetadataId}](https://help-api.delphix.com/hyperscale-compliance/27.0.0/hyperscale-compliance-apis-27.0.0/filemetadata/delete_file_metadata.md) ## StructuredDataFormat ### Create a Structured Data Format for XML/JSON masking. - [POST /structured-data-format](https://help-api.delphix.com/hyperscale-compliance/27.0.0/hyperscale-compliance-apis-27.0.0/structureddataformat/create_structureddataformat.md) ### Returns a list of Structured Data Formats. - [GET /structured-data-format](https://help-api.delphix.com/hyperscale-compliance/27.0.0/hyperscale-compliance-apis-27.0.0/structureddataformat/list_all_structureddataformat.md) ### Returns a structured data format info by ID. - [GET /structured-data-format/{structuredDataFormatId}](https://help-api.delphix.com/hyperscale-compliance/27.0.0/hyperscale-compliance-apis-27.0.0/structureddataformat/get_structureddataformat.md) ### Update an existing structured data format. - [PUT /structured-data-format/{structuredDataFormatId}](https://help-api.delphix.com/hyperscale-compliance/27.0.0/hyperscale-compliance-apis-27.0.0/structureddataformat/update_structureddataformat.md) ### Delete an existing structured data format. - [DELETE /structured-data-format/{structuredDataFormatId}](https://help-api.delphix.com/hyperscale-compliance/27.0.0/hyperscale-compliance-apis-27.0.0/structureddataformat/delete_structureddataformat.md) ## DataSets ### Create DataSet for hyperscale compliance. - [POST /data-sets](https://help-api.delphix.com/hyperscale-compliance/27.0.0/hyperscale-compliance-apis-27.0.0/datasets/create_dataset.md) ### Returns a list of dataSet. - [GET /data-sets](https://help-api.delphix.com/hyperscale-compliance/27.0.0/hyperscale-compliance-apis-27.0.0/datasets/list_all_dataset.md) ### Returns a dataSet info by ID. - [GET /data-sets/{dataSetId}](https://help-api.delphix.com/hyperscale-compliance/27.0.0/hyperscale-compliance-apis-27.0.0/datasets/get_dataset.md) ### Update an existing DataSet. - [PUT /data-sets/{dataSetId}](https://help-api.delphix.com/hyperscale-compliance/27.0.0/hyperscale-compliance-apis-27.0.0/datasets/update_dataset.md) ### Delete an existing dataSet. - [DELETE /data-sets/{dataSetId}](https://help-api.delphix.com/hyperscale-compliance/27.0.0/hyperscale-compliance-apis-27.0.0/datasets/delete_dataset.md) ### Create DataSet for hyperscale compliance using Uploaded File. - [POST /data-sets/file-upload](https://help-api.delphix.com/hyperscale-compliance/27.0.0/hyperscale-compliance-apis-27.0.0/datasets/create_dataset_using_file.md) ### Update DataSet for hyperscale compliance using Uploaded File. - [PUT /data-sets/file-upload/{dataSetId}](https://help-api.delphix.com/hyperscale-compliance/27.0.0/hyperscale-compliance-apis-27.0.0/datasets/update_dataset_using_file.md) ## Jobs ### Create a Hyperscale Compliance Job. - [POST /jobs](https://help-api.delphix.com/hyperscale-compliance/27.0.0/hyperscale-compliance-apis-27.0.0/jobs/create_job.md) ### Returns a list of Hyperscale Compliance Jobs. - [GET /jobs](https://help-api.delphix.com/hyperscale-compliance/27.0.0/hyperscale-compliance-apis-27.0.0/jobs/list_all_jobs.md) ### Returns a Job by ID. - [GET /jobs/{id}](https://help-api.delphix.com/hyperscale-compliance/27.0.0/hyperscale-compliance-apis-27.0.0/jobs/get_job_by_id.md) ### Update an existing Job. - [PUT /jobs/{id}](https://help-api.delphix.com/hyperscale-compliance/27.0.0/hyperscale-compliance-apis-27.0.0/jobs/update_job.md) ### Deletes the Job by Id - [DELETE /jobs/{id}](https://help-api.delphix.com/hyperscale-compliance/27.0.0/hyperscale-compliance-apis-27.0.0/jobs/delete_job.md) ## ApiKeys ### Returns a list of API keys. - [GET /api-keys](https://help-api.delphix.com/hyperscale-compliance/27.0.0/hyperscale-compliance-apis-27.0.0/apikeys/list_api_keys.md) ### 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. - [POST /api-keys](https://help-api.delphix.com/hyperscale-compliance/27.0.0/hyperscale-compliance-apis-27.0.0/apikeys/create_api_key.md) ### Get an API key by id - [GET /api-keys/{apiKeyId}](https://help-api.delphix.com/hyperscale-compliance/27.0.0/hyperscale-compliance-apis-27.0.0/apikeys/get_api_key.md) ### Delete an API key - [DELETE /api-keys/{apiKeyId}](https://help-api.delphix.com/hyperscale-compliance/27.0.0/hyperscale-compliance-apis-27.0.0/apikeys/delete_api_key.md) ## JobExecution ### Create an execution of a Hyperscale Job. - [POST /executions](https://help-api.delphix.com/hyperscale-compliance/27.0.0/hyperscale-compliance-apis-27.0.0/jobexecution/create_execution.md) ### Returns a list of all the executions of a Hyperscale Job in the detailed format. - [GET /executions](https://help-api.delphix.com/hyperscale-compliance/27.0.0/hyperscale-compliance-apis-27.0.0/jobexecution/list_all_execution.md) ### Returns a list of all the Execution summaries of a Hyperscale Job. - [GET /executions/summary](https://help-api.delphix.com/hyperscale-compliance/27.0.0/hyperscale-compliance-apis-27.0.0/jobexecution/list_all_execution_summaries.md) ### Returns the Job Execution Details by ID. - [GET /executions/{id}](https://help-api.delphix.com/hyperscale-compliance/27.0.0/hyperscale-compliance-apis-27.0.0/jobexecution/get_execution_by_id.md) ### Clean-up the execution by Id - [DELETE /executions/{id}](https://help-api.delphix.com/hyperscale-compliance/27.0.0/hyperscale-compliance-apis-27.0.0/jobexecution/clean_up_execution.md) ### Returns the Job Execution summary by its ID. - [GET /executions/{id}/summary](https://help-api.delphix.com/hyperscale-compliance/27.0.0/hyperscale-compliance-apis-27.0.0/jobexecution/get_execution_summary_by_id.md) ### Restart a failed execution. - [PUT /executions/{id}/restart](https://help-api.delphix.com/hyperscale-compliance/27.0.0/hyperscale-compliance-apis-27.0.0/jobexecution/restart_execution.md) ### Cancel a running execution. - [PUT /executions/{id}/cancel](https://help-api.delphix.com/hyperscale-compliance/27.0.0/hyperscale-compliance-apis-27.0.0/jobexecution/cancel_execution.md) ## Sync ### Import Global Settings to sync the Compliance Engines. - [POST /sync-compliance-engines](https://help-api.delphix.com/hyperscale-compliance/27.0.0/hyperscale-compliance-apis-27.0.0/sync/import_global_settings.md) ### Import Connectors and Data Set. - [POST /import](https://help-api.delphix.com/hyperscale-compliance/27.0.0/hyperscale-compliance-apis-27.0.0/sync/import_data_set.md) ### Update imported Data Set and Connectors. - [PUT /import/{dataSetId}](https://help-api.delphix.com/hyperscale-compliance/27.0.0/hyperscale-compliance-apis-27.0.0/sync/update_import_data_set.md) ## FileDownload ### Download Response in file. - [GET /file-download](https://help-api.delphix.com/hyperscale-compliance/27.0.0/hyperscale-compliance-apis-27.0.0/filedownload/file-download.md) ## FileUpload ### upload a file. - [POST /file-upload](https://help-api.delphix.com/hyperscale-compliance/27.0.0/hyperscale-compliance-apis-27.0.0/fileupload/file-upload.md) ## SupportBundle ### Generates support bundle - [POST /support-bundle](https://help-api.delphix.com/hyperscale-compliance/27.0.0/hyperscale-compliance-apis-27.0.0/supportbundle/generatesupportbundle.md): Generates support bundle ### Delete an existing support-bundle. - [DELETE /support-bundle/{asyncTaskId}](https://help-api.delphix.com/hyperscale-compliance/27.0.0/hyperscale-compliance-apis-27.0.0/supportbundle/delete_support_bundle_by_id.md) ## AsyncTask ### Returns a list of async tasks. - [GET /async-tasks](https://help-api.delphix.com/hyperscale-compliance/27.0.0/hyperscale-compliance-apis-27.0.0/asynctask/list_all_async_task.md) ### Returns an Async Task by ID. - [GET /async-tasks/{asyncTaskId}](https://help-api.delphix.com/hyperscale-compliance/27.0.0/hyperscale-compliance-apis-27.0.0/asynctask/get_async_task_by_id.md) ### Cancel an Async Task - [PUT /async-tasks/{id}/cancel](https://help-api.delphix.com/hyperscale-compliance/27.0.0/hyperscale-compliance-apis-27.0.0/asynctask/cancel_async_task.md)