Migrate job

The Migrate endpoint facilitates the seamless relocation of a masking job from one engine to another, ensuring the job's uniqueness is preserved throughout the process. This is particularly beneficial for organizational tasks, such as transitioning compliance jobs to a new engine in preparation for the retirement of the original engine, or merging jobs from multiple development engines into a single unit for streamlined administration. This operation guarantees that each job retains a singular instance, preventing the creation of duplicates. Moreover, the job maintains its original reference within DCT, providing a smooth transition with minimal disruption to existing workflows and configurations.

Example of finding all MaskingJob originating from engine with ID 2:

NONE

curl -X 'POST' \
  'https://<APPLIANCE_ADDRESS>/v3/masking-jobs/source-engines/search' \
  -H 'accept: application/json' \
  -H 'Authorization: <API_KEY>' \
  -H 'Content-Type: application/json' \
  -d '{
  "filter_expression": "source_enigne_id eq '\''2'\''"
}'

Example of migrating a MaskingJob to new source engine with ID 3 and placing it in the ‘prod-env’ environment:

NONE

curl -X 'POST' \
  'https://<APPLIANCE_ADDRESS>/v3/masking-jobs/d53812ce-9186-485d-a388-44bc52087ead/migrate' \
  -H 'accept: application/json' \
  -H 'Authorization: <API_KEY>' \
  -H 'Content-Type: application/json' \
  -d '{
  "target_engine_id": "3",
  "target_environment_id": "prod-env"
}'

Force overwrite

When migrating a compliance job, DCT provides a force overwrite option designed to override any existing job on the target engine with the same name, ensuring the latest job is applied without needing to manually resolve naming conflicts or version discrepancies. This can be particularly useful when updating a job with significant changes that need to be reflected immediately across environments.

Connector credentials are not automatically copied to the target engine due to security considerations. Therefore, the credentials must be explicitly set on the target engine's connector. DCT facilitates this by allowing the search, update, and testing of connectors directly through its UI.

Examples of managing connectors for a MaskingJob:

Listing connectors

CODE

curl -X 'GET' \
  'https://<APPLIANCE_ADDRESS>/v3/masking-jobs/d53812ce-9186-485d-a388-44bc52087ead/connectors' \
  -H 'accept: application/json' \
  -H 'Authorization: <API_KEY>'

Updating a connector’s credentials

CODE

curl -X 'PATCH' \
  'https://<APPLIANCE_ADDRESS>/v3/connectors/2-DATABASE-23' \
  -H 'accept: application/json' \
  -H 'Authorization: <API_KEY>' \
  -H 'Content-Type: application/json' \
  -d '{
  "username": "USER123",
  "password": "password123"
}'

Testing a connector

CODE

curl -X 'POST' \
  'https://<APPLIANCE_ADDRESS>/v3/connectors/2-DATABASE-23/test' \
  -H 'accept: application/json' \
  -H 'Authorization: <API_KEY>'