27.0
2025.2.0
2025.1.0
2025.2.0
Search
Engines
post
Register an engine.
get
Returns a list of registered engines.
get
Returns a registered engine by ID.
put
Update a registered engine.
del
Unregister an engine.
Vaults
get
Returns a list of configured Hashicorp vaults.
post
Configure a new Hashicorp Vault
get
Get a Hashicorp vault by id
del
Delete a Hashicorp vault by id
MountFileSystem
get
Returns the configured Mount File System.
get
Validate the permissions for the File Mount.
ConnectorInfo
post
Create Connector Info for hyperscale compliance.
get
Returns a list of connector info.
get
Returns a connector info by ID.
put
Update an existing Connector Info.
del
Delete an existing connector info.
FileMetadata
post
Create a file metadata.
get
Returns a list of file metadata.
get
Returns a file metadata by ID.
put
Update an existing file metadata.
del
Delete an existing file metadata.
StructuredDataFormat
post
Create a Structured Data Format for XML/JSON masking.
get
Returns a list of Structured Data Formats.
get
Returns a structured data format info by ID.
put
Update an existing structured data format.
del
Delete an existing structured data format.
DataSets
post
Create DataSet for hyperscale compliance.
get
Returns a list of dataSet.
get
Returns a dataSet info by ID.
put
Update an existing DataSet.
del
Delete an existing dataSet.
post
Create DataSet for hyperscale compliance using Uploaded File.
put
Update DataSet for hyperscale compliance using Uploaded File.
Jobs
post
Create a Hyperscale Compliance Job.
get
Returns a list of Hyperscale Compliance Jobs.
get
Returns a Job by ID.
put
Update an existing Job.
del
Deletes the Job by Id
ApiKeys
get
Returns a list of API keys.
post
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.
get
Get an API key by id
del
Delete an API key
JobExecution
post
Create an execution of a Hyperscale Job.
get
Returns a list of all the executions of a Hyperscale Job in the detailed format.
get
Returns a list of all the Execution summaries of a Hyperscale Job.
get
Returns the Job Execution Details by ID.
del
Clean-up the execution by Id
get
Returns the Job Execution summary by its ID.
put
Restart a failed execution.
put
Cancel a running execution.
Sync
post
Import Global Settings to sync the Compliance Engines.
post
Import Connectors and Data Set.
put
Update imported Data Set and Connectors.
FileDownload
get
Download Response in file.
FileUpload
post
upload a file.
SupportBundle
post
Generates support bundle
del
Delete an existing support-bundle.
AsyncTask
get
Returns a list of async tasks.
get
Returns an Async Task by ID.
put
Cancel an Async Task
FileDownload
Download Response in file.
Security
ApiKeyAuth
Request
query Parameters
entity_type
required
string
Default:
"DATASET"
Entity to download response .
Enum:
"DATASET"
"EXECUTION"
"SUPPORT_BUNDLE"
id
required
integer
<int64>
id of the entity to download .
Responses
200
OK
get
/file-download
Try it
Response samples
200
application/octet-stream
application/json
application/octet-stream
No sample
➔ Next to
FileUpload