Data Export Configuration

The following API commands enable you to export data from the Control-M SaaS database to use in data analytics, reporting, or integration with your enterprise systems.

For more information, see Exporting Control-M SaaS Data.

config dataExport:activate::set

The config dataExport:activate::set command enables you to activate or deactivate the Data Export feature or to update the password to protect exported data.

After running this command, wait several minutes for file generation before you run the config dataExport::get API command to retrieve exported data.

  • CLI

  • REST

config dataExport:activate::set <enabled> [password]

The following example shows the REST API syntax for the config dataExport:activate::set command in cURL:

Copy 
curl -H "x-api-key: $token" -X POST -d '{"enabled": "true","password": "$password}' \
"$endpoint/config/dataExport/activate" 

The following table describes the config dataExport:activate::set command parameters.

Parameter

Description

enabled

Determines whether to acitvate or deactivate the Data Export feature.

Valid Values:

  • true: Activates the Data Export feature

  • false: Deactivates the Data Export feature

Default: false

password

Defines a password to protect access to the generated dumpfiles that contain the exported data.

This parameter is required only when enabled is set to true.

Password Rules:

  • At least one lowercase alphabetical character

  • At least one uppercase alphabetical character

  • At least one special character

  • Minimum length: 8 characters

  • Maximum length: 12 characters

config dataExport::get

The config dataExport::get command retrieves a dumpfile that contains data exported from the Control-M SaaS database.

The command returns a download URL that you can access within 60 seconds to download the password-protected, zipped dumpfile. To open the dumpfile, use the password that you set when you activated the Data Export feature using the config dataExport:activate::set command.

  • CLI

  • REST

config dataExport::get <dataType> [name]

The following example shows the REST API syntax for the config dataExport::get command in cURL:

Copy 
curl -H "x-api-key: $token" "$endpoint/config/dataExport?dataType=CTM&name=IN01"

The following table describes the config dataExport::get command parameters.

Parameter

Description

dataType

Determines the type of data to export from the Control-M SaaS database.

Valid Values:

  • EM: Control-M/EM data, in a zipped dumpfile named EM_DumpFile.

  • CTM: Control-M/Server data, in a zipped dumpfile named <serverName>_DumpFile.

  • RunInfo: Job run data, in a zipped dumpfile named EM_RunInfoDumpFile.

name

Defines the Control-M/Server name.

This parameter is required only when dataType is set to CTM.