Create a ReplicationProfile.

Request

Security

ApiKeyAuth

Bodyapplication/json

The parameters to create a ReplicationProfile.

namestring

The ReplicationProfile name.

replication_modestringrequired

The ReplicationProfile mode.

Enum:"ENGINE_DATA_REPLICATION""MASKED_DATA_DISTRIBUTION""CONTINUOUS_VAULT"

engine_idstringrequired

The ID of the engine that the ReplicationProfile belongs to.

target_engine_idstringrequired

The ID of the replication target engine.

target_hoststring

Hostname of the replication target engine. If none is provided, the hostname for the engine referenced by target_engine_id will be used.

target_portinteger, [ 0 .. 65535 ]

Target TCP port number for the Delphix Session Protocol.

Default:8415

descriptionstring, <= 4096 characters

The ReplicationProfile description.

schedulestring, [ 1 .. 256 ] characters

Replication schedule in the form of a quartz-formatted string.

tagsArray of objects(Tag)

The tags that are applied to this ReplicationProfile.

enable_tag_replicationboolean

Indicates whether tag replication from primary object to replica object is enabled or disabled for this ReplicationProfile.

bandwidth_limitinteger, >= 0

Bandwidth limit (MB/s) for replication network traffic. A value of 0 means no limit.

Default:0

number_of_connectionsinteger, [ 1 .. 16 ]

Total number of transport connections to use.

Default:1

encryptedboolean

Encrypt replication network traffic.

Default:false

automatic_replicationboolean

Indication whether the replication spec schedule is enabled or not.

Default:false

use_system_socks_settingboolean

Connect to the replication target host via the system-wide SOCKS proxy.

Default:false

vdb_idsArray of strings

The VDBs that are replicated by this ReplicationProfile.

dsource_idsArray of strings

The dSources that are replicated by this ReplicationProfile.

cdb_idsArray of strings

The CDBs that are replicated by this ReplicationProfile.

vcdb_idsArray of strings

The vCDBs that are replicated by this ReplicationProfile.

group_idsArray of strings

The groups that are replicated by this ReplicationProfile.

replicate_entire_engineboolean

Whether to replicate the entire engine. This is mutually exclusive with the vdb_ids, dsource_ids, cdb_ids, vcdb_ids, and group_ids properties.

The request example is intended for creating a ReplicationProfile.

curl -i -X POST \
  https://help-api.delphix.com/_mock/data-control-tower/continuous-data/23.0.0/continuous-data-apis-dct-23.0.0/replication-profiles \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "name": "replication-profile-name",
    "replication_mode": "ENGINE_DATA_REPLICATION",
    "engine_id": 1,
    "target_engine_id": 2,
    "target_port": 8415,
    "description": "description",
    "schedule": "0 0 0 * * ?",
    "tags": [
      {
        "key": "key1",
        "value": "value1"
      },
      {
        "key": "key2",
        "value": "value2"
      }
    ],
    "enable_tag_replication": true,
    "bandwidth_limit": 0,
    "number_of_connections": 1,
    "encrypted": false,
    "automatic_replication": false,
    "use_system_socks_setting": false,
    "group_ids": [
      "1-GROUP-1"
    ]
  }'

Responses

ReplicationProfile created

Bodyapplication/json

jobobject(Job)

An asynchronous task.

replication_profile_idstring

The id of the created ReplicationProfile.

Example:"1-REPLICATION_PROFILE-1"

Response

{
  "job": {
    "id": "job-123",
    "status": "RUNNING",
    "is_waiting_for_telemetry": true,
    "type": "DB_REFRESH",
    "localized_type": "DB Refresh",
    "error_details": "Unable to connect to the engine.",
    "warning_message": "Failed to remove local MaskingJob, engineId: 3 localMaskingJobId: 7.",
    "target_id": "vdb-123",
    "target_name": "vdb",
    "start_time": "2022-01-02T05:11:24.148Z",
    "update_time": "2022-01-02T06:11:24.148Z",
    "trace_id": "string",
    "engine_ids": [ … ],
    "tags": [ … ],
    "engines": [ … ],
    "account_id": 1,
    "account_name": "User 1",
    "percent_complete": 50,
    "virtualization_tasks": [ … ],
    "tasks": [ … ],
    "execution_id": "string"
  },
  "replication_profile_id": "1-REPLICATION_PROFILE-1"
}