Replication

List all ReplicationProfiles.

SecurityApiKeyAuth
Request
query Parameters
limit
integer [ 1 .. 1000 ]
Default: 100

Maximum number of objects to return per query. The value must be between 1 and 1000. Default is 100.

Example: limit=50
cursor
string [ 1 .. 4096 ] characters

Cursor to fetch the next or previous page of results. The value of this property must be extracted from the 'prev_cursor' or 'next_cursor' property of a PaginatedResponseMetadata which is contained in the response of list and search API endpoints.

sort
string or null

The field to sort results by. A property name with a prepended '-' signifies descending order.

Enum: "id" "-id" "name" "-name" "replication_mode" "-replication_mode" "engine_id" "-engine_id" "target_engine_id" "-target_engine_id" "target_host" "-target_host" "target_port" "-target_port" "replication_tag" "-replication_tag" "type" "-type" "encrypted" "-encrypted" "automatic_replication" "-automatic_replication" "use_system_socks_setting" "-use_system_socks_setting" "bandwidth_limit" "-bandwidth_limit" "number_of_connections" "-number_of_connections" "last_execution_status" "-last_execution_status" "last_execution_status_timestamp" "-last_execution_status_timestamp"
Example: sort=id
Responses
200

OK

get/replication-profiles
Response samples
application/json
{
  • "items": [
    ],
  • "response_metadata": {
    }
}

Create a ReplicationProfile.

SecurityApiKeyAuth
Request
Request Body schema: application/json

The parameters to create a ReplicationProfile.

name
string

The ReplicationProfile name.

replication_mode
required
string

The ReplicationProfile mode.

Enum: "ENGINE_DATA_REPLICATION" "MASKED_DATA_DISTRIBUTION" "CONTINUOUS_VAULT"
engine_id
required
string

The ID of the engine that the ReplicationProfile belongs to.

target_engine_id
required
string

The ID of the replication target engine.

target_host
string

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

target_port
integer [ 0 .. 65535 ]
Default: 8415

Target TCP port number for the Delphix Session Protocol.

description
string <= 4096 characters

The ReplicationProfile description.

schedule
string [ 1 .. 256 ] characters

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

Array of objects (Tag)

The tags that are applied to this ReplicationProfile.

enable_tag_replication
boolean

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

bandwidth_limit
integer >= 0
Default: 0

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

number_of_connections
integer [ 1 .. 16 ]
Default: 1

Total number of transport connections to use.

encrypted
boolean
Default: false

Encrypt replication network traffic.

automatic_replication
boolean
Default: false

Indication whether the replication spec schedule is enabled or not.

use_system_socks_setting
boolean
Default: false

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

vdb_ids
Array of strings

The VDBs that are replicated by this ReplicationProfile.

dsource_ids
Array of strings

The dSources that are replicated by this ReplicationProfile.

cdb_ids
Array of strings

The CDBs that are replicated by this ReplicationProfile.

vcdb_ids
Array of strings

The vCDBs that are replicated by this ReplicationProfile.

group_ids
Array of strings

The groups that are replicated by this ReplicationProfile.

replicate_entire_engine
boolean

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

Responses
201

ReplicationProfile created

post/replication-profiles
Request samples
application/json

The request example is intended for creating a ReplicationProfile.

{
  • "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": [
    ],
  • "enable_tag_replication": true,
  • "bandwidth_limit": 0,
  • "number_of_connections": 1,
  • "encrypted": false,
  • "automatic_replication": false,
  • "use_system_socks_setting": false,
  • "group_ids": [
    ]
}
Response samples
application/json
{
  • "job": {
    },
  • "replication_profile_id": "1-REPLICATION_PROFILE-1"
}

Search for ReplicationProfiles.

SecurityApiKeyAuth
Request
query Parameters
limit
integer [ 1 .. 1000 ]
Default: 100

Maximum number of objects to return per query. The value must be between 1 and 1000. Default is 100.

Example: limit=50
cursor
string [ 1 .. 4096 ] characters

Cursor to fetch the next or previous page of results. The value of this property must be extracted from the 'prev_cursor' or 'next_cursor' property of a PaginatedResponseMetadata which is contained in the response of list and search API endpoints.

sort
string or null

The field to sort results by. A property name with a prepended '-' signifies descending order.

Enum: "id" "-id" "name" "-name" "replication_mode" "-replication_mode" "engine_id" "-engine_id" "target_engine_id" "-target_engine_id" "target_host" "-target_host" "target_port" "-target_port" "replication_tag" "-replication_tag" "type" "-type" "encrypted" "-encrypted" "automatic_replication" "-automatic_replication" "use_system_socks_setting" "-use_system_socks_setting" "bandwidth_limit" "-bandwidth_limit" "number_of_connections" "-number_of_connections" "last_execution_status" "-last_execution_status" "last_execution_status_timestamp" "-last_execution_status_timestamp"
Example: sort=id
Request Body schema: application/json

A request body containing a filter expression. This enables searching for items matching arbitrarily complex conditions. The list of attributes which can be used in filter expressions is available in the x-filterable vendor extension.

Filter Expression Overview

Note: All keywords are case-insensitive

Comparison Operators

Operator Description Example
CONTAINS Substring or membership testing for string and list attributes respectively. field3 CONTAINS 'foobar', field4 CONTAINS TRUE
IN Tests if field is a member of a list literal. List can contain a maximum of 100 values field2 IN ['Goku', 'Vegeta']
GE Tests if a field is greater than or equal to a literal value field1 GE 1.2e-2
GT Tests if a field is greater than a literal value field1 GT 1.2e-2
LE Tests if a field is less than or equal to a literal value field1 LE 9000
LT Tests if a field is less than a literal value field1 LT 9.02
NE Tests if a field is not equal to a literal value field1 NE 42
EQ Tests if a field is equal to a literal value field1 EQ 42

Search Operator

The SEARCH operator filters for items which have any filterable attribute that contains the input string as a substring, comparison is done case-insensitively. This is not restricted to attributes with string values. Specifically SEARCH '12' would match an item with an attribute with an integer value of 123.

Logical Operators

Ordered by precedence.

Operator Description Example
NOT Logical NOT (Right associative) NOT field1 LE 9000
AND Logical AND (Left Associative) field1 GT 9000 AND field2 EQ 'Goku'
OR Logical OR (Left Associative) field1 GT 9000 OR field2 EQ 'Goku'

Grouping

Parenthesis () can be used to override operator precedence.

For example: NOT (field1 LT 1234 AND field2 CONTAINS 'foo')

Literal Values

Literal Description Examples
Nil Represents the absence of a value nil, Nil, nIl, NIL
Boolean true/false boolean true, false, True, False, TRUE, FALSE
Number Signed integer and floating point numbers. Also supports scientific notation. 0, 1, -1, 1.2, 0.35, 1.2e-2, -1.2e+2
String Single or double quoted "foo", "bar", "foo bar", 'foo', 'bar', 'foo bar'
Datetime Formatted according to RFC3339 2018-04-27T18:39:26.397237+00:00
List Comma-separated literals wrapped in square brackets [0], [0, 1], ['foo', "bar"]

Limitations

  • A maximum of 8 unique identifiers may be used inside a filter expression.
filter_expression
string [ 5 .. 2000 ] characters
Responses
200

OK

post/replication-profiles/search
Request samples
application/json

An example of a nested Object comparison testing that at least one repository has a version which is equal to 19.0.0.

{
  • "filter_expression": "repositories CONTAINS {version eq '19.0.0'}"
}
Response samples
application/json
{
  • "items": [
    ],
  • "response_metadata": {
    }
}

Execute a ReplicationProfile.

SecurityApiKeyAuth
Request
path Parameters
replicationProfileId
required
string non-empty

The ID of the ReplicationProfile.

Responses
200

ReplicationProfile executed.

post/replication-profiles/{replicationProfileId}/execute
Response samples
application/json
{
  • "job": {
    }
}

Get a ReplicationProfile by ID.

SecurityApiKeyAuth
Request
path Parameters
replicationProfileId
required
string non-empty

The ID of the ReplicationProfile.

Responses
200

OK

get/replication-profiles/{replicationProfileId}
Response samples
application/json
{
  • "id": "string",
  • "name": "string",
  • "replication_mode": "ENGINE_DATA_REPLICATION",
  • "engine_id": "string",
  • "target_engine_id": "string",
  • "target_host": "string",
  • "target_port": 8415,
  • "type": "string",
  • "description": "string",
  • "last_execution_status": "RUNNING",
  • "last_execution_status_timestamp": "2019-08-24T14:15:22Z",
  • "schedule": "string",
  • "replication_tag": "string",
  • "replication_objects": [
    ],
  • "tags": [
    ],
  • "enable_tag_replication": true,
  • "bandwidth_limit": 0,
  • "number_of_connections": 1,
  • "encrypted": false,
  • "automatic_replication": false,
  • "use_system_socks_setting": false,
  • "vdb_ids": [
    ],
  • "dsource_ids": [
    ],
  • "cdb_ids": [
    ],
  • "vcdb_ids": [
    ],
  • "group_ids": [
    ],
  • "replicate_entire_engine": true,
  • "data_layout_ids": [
    ]
}

Delete a ReplicationProfile.

SecurityApiKeyAuth
Request
path Parameters
replicationProfileId
required
string non-empty

The ID of the ReplicationProfile.

Responses
200

OK

delete/replication-profiles/{replicationProfileId}
Response samples
application/json
{
  • "job": {
    }
}

Update a ReplicationProfile.

SecurityApiKeyAuth
Request
path Parameters
replicationProfileId
required
string non-empty

The ID of the ReplicationProfile.

Request Body schema: application/json
required
name
string

The ReplicationProfile name.

description
string <= 4096 characters

The ReplicationProfile description.

target_engine_id
string

The ID of the replication target engine.

target_host
string

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

target_port
integer [ 0 .. 65535 ]

Target TCP port number for the Delphix Session Protocol.

replication_mode
string

The ReplicationProfile mode.

Enum: "ENGINE_DATA_REPLICATION" "MASKED_DATA_DISTRIBUTION" "CONTINUOUS_VAULT"
schedule
string [ 1 .. 256 ] characters

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

vdb_ids
Array of strings

The VDBs that are replicated by this ReplicationProfile.

dsource_ids
Array of strings

The dSources that are replicated by this ReplicationProfile.

cdb_ids
Array of strings

The CDBs that are replicated by this ReplicationProfile.

vcdb_ids
Array of strings

The vCDBs that are replicated by this ReplicationProfile.

group_ids
Array of strings

The groups that are replicated by this ReplicationProfile.

enable_tag_replication
boolean

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

replicate_entire_engine
boolean

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

bandwidth_limit
integer >= 0

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

number_of_connections
integer [ 1 .. 16 ]

Total number of transport connections to use.

encrypted
boolean

Encrypt replication network traffic.

automatic_replication
boolean

Indication whether the replication spec schedule is enabled or not.

use_system_socks_setting
boolean

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

Responses
200

OK

patch/replication-profiles/{replicationProfileId}
Request samples
application/json
{
  • "name": "string",
  • "description": "string",
  • "target_engine_id": "string",
  • "target_host": "string",
  • "target_port": 65535,
  • "replication_mode": "ENGINE_DATA_REPLICATION",
  • "schedule": "string",
  • "vdb_ids": [
    ],
  • "dsource_ids": [
    ],
  • "cdb_ids": [
    ],
  • "vcdb_ids": [
    ],
  • "group_ids": [
    ],
  • "enable_tag_replication": true,
  • "replicate_entire_engine": true,
  • "bandwidth_limit": 0,
  • "number_of_connections": 1,
  • "encrypted": true,
  • "automatic_replication": true,
  • "use_system_socks_setting": true
}
Response samples
application/json
{
  • "job": {
    }
}

Get tags for a ReplicationProfile.

SecurityApiKeyAuth
Request
path Parameters
replicationProfileId
required
string non-empty

The ID of the ReplicationProfile.

Responses
200

Ok

get/replication-profiles/{replicationProfileId}/tags
Response samples
application/json
{
  • "tags": [
    ]
}

Create tags for a ReplicationProfile.

SecurityApiKeyAuth
Request
path Parameters
replicationProfileId
required
string non-empty

The ID of the ReplicationProfile.

Request Body schema: application/json
required

Tags information for ReplicationProfiles.

required
Array of objects (Tag) [ 1 .. 1000 ] items unique

Array of tags with key value pairs

Responses
201

Created

post/replication-profiles/{replicationProfileId}/tags
Request samples
application/json
{
  • "tags": [
    ]
}
Response samples
application/json
{
  • "tags": [
    ]
}

Delete tags for a ReplicationProfile.

SecurityApiKeyAuth
Request
path Parameters
replicationProfileId
required
string non-empty

The ID of the ReplicationProfile.

Request Body schema: application/json

The parameters to delete tags

key
string [ 1 .. 4000 ] characters

Key of the tag

value
string [ 1 .. 4000 ] characters

Value of the tag

Array of objects (Tag) [ 1 .. 1000 ] items unique

List of tags to be deleted

Responses
204

No Content

post/replication-profiles/{replicationProfileId}/tags/delete
Request samples
application/json

Delete all tags for given object - No request body required

{ }

Enable tag replication for given ReplicationProfile.

SecurityApiKeyAuth
Request
path Parameters
replicationProfileId
required
string non-empty

The ID of the ReplicationProfile.

Responses
202

Accepted

post/replication-profiles/{replicationProfileId}/enable-tag-replication

Disable tag replication for given ReplicationProfile.

SecurityApiKeyAuth
Request
path Parameters
replicationProfileId
required
string non-empty

The ID of the ReplicationProfile.

Responses
200

OK

post/replication-profiles/{replicationProfileId}/disable-tag-replication
➔ Next to VirtualizationJobs