sync

Export masking object

Export masking objects

Securityapi_key
Request
Request Body schema: application/json
required

The identifier for the masking object to export

Array
objectIdentifier
required
object
objectType
required
string

Type of object to export

Enum: "ALGORITHM_PLUGIN" "ALGORITHM_REFERENCE" "APPLICATION_SETTINGS" "BINARYLOOKUP" "CLASSIFIER" "CLASSIFIER_REFERENCE" "CLEANSING" "CREDENTIAL_PATH" "DATABASE_CONNECTOR" "DATABASE_RULESET" "DATASET_CONNECTOR" "DATASET_RULESET" "DATASET_FORMAT" "DATE_SHIFT" "DOMAIN" "DOMAIN_REFERENCE" "DRIVER_SUPPORT_PLUGIN" "ENVIRONMENT" "FILE_CONNECTOR" "FILE_FORMAT" "FILE_RULESET" "GLOBAL_OBJECT" "JDBC_DRIVER" "KEY" "LICENSE_INFO" "LOOKUP" "MAPPLET" "MASKING_JOB" "MIN_MAX" "MOUNT_INFORMATION" "PASSWORD_VAULT" "PROFILE_JOB" "PROFILE_SET" "PROFILE_SET_REFERENCE" "REDACTION" "REIDENTIFICATION_JOB" "SEGMENT" "SOURCE_DATABASE_CONNECTOR" "SOURCE_DATASET_CONNECTOR" "SOURCE_FILE_CONNECTOR" "TOKENIZATION" "TOKENIZATION_JOB" "USER_ALGORITHM"
revisionHash
string

Global comparison value for the syncable object that gets recalculated upon update to any object along its dependency chain

revisionId
string

Global ID for the syncable object that gets recalculated only upon update to its own object

Responses
201

Success

400

Bad request

401

Unauthorized access

404

Not found

post/export
Request samples
application/json
[
  • {
    }
]
Response samples
application/json
{
  • "exportResponseMetadata": { },
  • "blob": "string",
  • "signature": "string",
  • "publicKey": "string"
}

Export masking object

Export masking objects

Securityapi_key
Request
query Parameters
structure
string

The structure of the resulting export bundle.

Enum: "ZIP" "BLOB"
Request Body schema: application/json
required

The identifier for the masking object to export

Array
objectIdentifier
required
object
objectType
required
string

Type of object to export

Enum: "ALGORITHM_PLUGIN" "ALGORITHM_REFERENCE" "APPLICATION_SETTINGS" "BINARYLOOKUP" "CLASSIFIER" "CLASSIFIER_REFERENCE" "CLEANSING" "CREDENTIAL_PATH" "DATABASE_CONNECTOR" "DATABASE_RULESET" "DATASET_CONNECTOR" "DATASET_RULESET" "DATASET_FORMAT" "DATE_SHIFT" "DOMAIN" "DOMAIN_REFERENCE" "DRIVER_SUPPORT_PLUGIN" "ENVIRONMENT" "FILE_CONNECTOR" "FILE_FORMAT" "FILE_RULESET" "GLOBAL_OBJECT" "JDBC_DRIVER" "KEY" "LICENSE_INFO" "LOOKUP" "MAPPLET" "MASKING_JOB" "MIN_MAX" "MOUNT_INFORMATION" "PASSWORD_VAULT" "PROFILE_JOB" "PROFILE_SET" "PROFILE_SET_REFERENCE" "REDACTION" "REIDENTIFICATION_JOB" "SEGMENT" "SOURCE_DATABASE_CONNECTOR" "SOURCE_DATASET_CONNECTOR" "SOURCE_FILE_CONNECTOR" "TOKENIZATION" "TOKENIZATION_JOB" "USER_ALGORITHM"
revisionHash
string

Global comparison value for the syncable object that gets recalculated upon update to any object along its dependency chain

revisionId
string

Global ID for the syncable object that gets recalculated only upon update to its own object

Responses
201

Success

400

Bad request

401

Unauthorized access

404

Not found

409

Conflict

post/export-async
Request samples
application/json
[
  • {
    }
]
Response samples
application/json
{
  • "asyncTaskId": 1,
  • "operation": "RULESET_REFRESH",
  • "reference": 13,
  • "status": "RUNNING",
  • "cancellable": false
}

Delete all export documents from /async-export tasks

Securityapi_key
Responses
200

Success

400

Bad request

401

Unauthorized access

delete/export-async

Import masking objects

Import masking objects

Securityapi_key
Request
query Parameters
force_overwrite
required
boolean

Specify whether the import should fail if an object already exists with the same ID or the existing object should be overwritten.

environment_id
integer <int32>

The ID of the environment to import objects into

source_environment_id
integer <int32>

The ID of the source environment to import on-the-fly connectors into

Request Body schema: application/json
required

The identifier for the masking object to import

exportResponseMetadata
required
object
blob
required
string

Export package containing data representing masking object

signature
required
string

Cryptographic signature of the blob

publicKey
required
string

Public version of the key used to generate the signature

Responses
201

Success

400

Bad request

401

Unauthorized access

404

Not found

post/import
Request samples
application/json
{
  • "exportResponseMetadata": { },
  • "blob": "string",
  • "signature": "string",
  • "publicKey": "string"
}
Response samples
application/json
[
  • {
    }
]

Import masking objects

WARNING: The generated curl command is incorrect, so please refer to the Masking API guide for instructions on how to upload files through the API

Securityapi_key
Request
query Parameters
force_overwrite
required
boolean

Specify whether the import should fail if an object already exists with the same ID or the existing object should be overwritten.

environment_id
integer <int32>

The ID of the environment to import objects into

source_environment_id
integer <int32>

The ID of the source environment to import on-the-fly connectors into

Request Body schema: multipart/form-data
required
file
required
string <binary>

The file to be uploaded.

Responses
201

Success

400

Bad request

401

Unauthorized access

404

Not found

409

Conflict

post/import-async
Response samples
application/json
{
  • "asyncTaskId": 1,
  • "operation": "RULESET_REFRESH",
  • "reference": 13,
  • "status": "RUNNING",
  • "cancellable": false
}

Delete all import documents from /async-import tasks

Securityapi_key
Responses
200

Success

400

Bad request

401

Unauthorized access

delete/import-async

Get all syncable objects

Get all syncable objects

Securityapi_key
Request
query Parameters
page_number
integer <int64>
Default: 1

The page number for which to get syncable objects. This will default to the first page if excluded

page_size
integer <int64>

The maximum number of objects to return. This will default to the DefaultApiPageSize setting if not provided

object_type
string

The type of syncable object to filter for

Enum: "ALGORITHM_PLUGIN" "APPLICATION_SETTINGS" "CLASSIFIER" "CREDENTIAL_PATH" "DATABASE_CONNECTOR" "DATABASE_RULESET" "DATASET_CONNECTOR" "DATASET_RULESET" "DATASET_FORMAT" "DOMAIN" "DRIVER_SUPPORT_PLUGIN" "ENVIRONMENT" "FILE_CONNECTOR" "FILE_FORMAT" "FILE_RULESET" "GLOBAL_OBJECT" "JDBC_DRIVER" "KEY" "LICENSE_INFO" "MASKING_JOB" "MOUNT_INFORMATION" "PASSWORD_VAULT" "PROFILE_JOB" "PROFILE_SET" "REIDENTIFICATION_JOB" "TOKENIZATION_JOB" "USER_ALGORITHM"
Responses
200

Success

400

Bad request

401

Unauthorized access

get/syncable-objects
Response samples
application/json
{
  • "_pageInfo": {
    },
  • "responseList": [
    ]
}

Get syncable object for environment

Get syncable object for environment

Securityapi_key
Request
path Parameters
environmentId
required
integer <int32>

The ID of the environment to retrieve syncable object of

Responses
200

Success

400

Bad request

401

Unauthorized access

get/syncable-objects/environments/{environmentId}
Response samples
application/json
{
  • "_pageInfo": {
    },
  • "responseList": [
    ]
}
➔ Next to fileConnector