VDBs

List all vdbs.

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" "database_name" "-database_name" "database_type" "-database_type" "name" "-name" "database_version" "-database_version" "size" "-size" "engine_id" "-engine_id" "status" "-status" "environment_id" "-environment_id" "ip_address" "-ip_address" "fqdn" "-fqdn" "parent_id" "-parent_id" "parent_dsource_id" "-parent_dsource_id" "group_name" "-group_name" "creation_date" "-creation_date" "last_refreshed_date" "-last_refreshed_date" "engine_name" "-engine_name" "storage_size" "-storage_size" "locked_by" "-locked_by" "locked_by_name" "-locked_by_name" "primary_object_id" "-primary_object_id" "primary_engine_id" "-primary_engine_id" "primary_engine_name" "-primary_engine_name" "content_type" "-content_type" "exported_data_directory" "-exported_data_directory" "vcdb_exported_data_directory" "-vcdb_exported_data_directory" "invoke_datapatch" "-invoke_datapatch" "instance_name" "-instance_name" "instance_number" "-instance_number" "repository_id" "-repository_id"
Example: sort=id
permission
string (PermissionEnum)

Restrict the objects, which are allowed.

Enum: "READ" "UPDATE" "DELETE" "EXECUTE" "CANCEL" "MIGRATE" "REFRESH" "DISABLE" "ENABLE" "ABANDON" "VALIDATE" "START" "STOP" "SNAPSHOT" "COPY" "REMOVE_JOB" "PASSWORD_RESET" "UNDO_IMPORT" "IMPORT" "PROVISION_FROM_BOOKMARK" "PROVISION" "REFRESH_FROM_BOOKMARK" "REFRESH_FROM_SNAPSHOT" "REFRESH_FROM_TIMESTAMP" "REFRESH_FROM_LOCATION" "CREATE_ENVIRONMENT" "CREATE_BOOKMARK" "CREATE_VDBGROUP" "MANAGE_TAGS" "LINK" "REPLICATE" "REPLICATE_TO" "CONVERT_AND_DROP" "IMPORT_BOOKMARKS" "FAILOVER" "COMMIT_FAILOVER" "FAILBACK" "DISCARD" "LOCK" "UNLOCK" "FORCE_UNLOCK" "LOCK_FOR_OTHER_ACCOUNT" "UPDATE_TIMEFLOW" "SNAPSHOT_DELETE" "SWITCH_TIMEFLOW" "DELETE_TIMEFLOW" "SNAPSHOT_UPDATE" "IMPORT_ACCOUNTS" "DETACH_SOURCE" "ATTACH_SOURCE" "RESOLVE" "RESOLVE_ALL" "RESOLVE_OR_IGNORE" "API_KEY_RESET" "API_KEY_DELETE" "READ_STORAGE_CAPACITY_DATA" "DELETE_BOOKMARK" "UPDATE_BOOKMARK" "READ_BOOKMARK" "UPLOAD_MASKING_FILE" "GLOBAL_SYNC_ENGINES" "ADD_ENGINE_TO_HYPERSCALE" "CONFIGURE_CUSTOM_AUTO_TAGGING" "CONFIGURE_PREDEFINED_AUTO_TAGGING" "APPLY" "UNAPPLY" "UNDO_REFRESH" "CONVERT" "REPAIR_TIMEFLOW"
Example: permission=READ
Responses
200

OK

get/vdbs
Response samples
application/json
{
  • "items": [
    ],
  • "errors": [
    ],
  • "response_metadata": {
    }
}

Search for VDBs.

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" "database_name" "-database_name" "database_type" "-database_type" "name" "-name" "database_version" "-database_version" "size" "-size" "engine_id" "-engine_id" "status" "-status" "environment_id" "-environment_id" "ip_address" "-ip_address" "fqdn" "-fqdn" "parent_id" "-parent_id" "parent_dsource_id" "-parent_dsource_id" "group_name" "-group_name" "creation_date" "-creation_date" "last_refreshed_date" "-last_refreshed_date" "engine_name" "-engine_name" "storage_size" "-storage_size" "locked_by" "-locked_by" "locked_by_name" "-locked_by_name" "primary_object_id" "-primary_object_id" "primary_engine_id" "-primary_engine_id" "primary_engine_name" "-primary_engine_name" "content_type" "-content_type" "exported_data_directory" "-exported_data_directory" "vcdb_exported_data_directory" "-vcdb_exported_data_directory" "invoke_datapatch" "-invoke_datapatch" "instance_name" "-instance_name" "instance_number" "-instance_number" "repository_id" "-repository_id"
Example: sort=id
permission
string (PermissionEnum)

Restrict the objects, which are allowed.

Enum: "READ" "UPDATE" "DELETE" "EXECUTE" "CANCEL" "MIGRATE" "REFRESH" "DISABLE" "ENABLE" "ABANDON" "VALIDATE" "START" "STOP" "SNAPSHOT" "COPY" "REMOVE_JOB" "PASSWORD_RESET" "UNDO_IMPORT" "IMPORT" "PROVISION_FROM_BOOKMARK" "PROVISION" "REFRESH_FROM_BOOKMARK" "REFRESH_FROM_SNAPSHOT" "REFRESH_FROM_TIMESTAMP" "REFRESH_FROM_LOCATION" "CREATE_ENVIRONMENT" "CREATE_BOOKMARK" "CREATE_VDBGROUP" "MANAGE_TAGS" "LINK" "REPLICATE" "REPLICATE_TO" "CONVERT_AND_DROP" "IMPORT_BOOKMARKS" "FAILOVER" "COMMIT_FAILOVER" "FAILBACK" "DISCARD" "LOCK" "UNLOCK" "FORCE_UNLOCK" "LOCK_FOR_OTHER_ACCOUNT" "UPDATE_TIMEFLOW" "SNAPSHOT_DELETE" "SWITCH_TIMEFLOW" "DELETE_TIMEFLOW" "SNAPSHOT_UPDATE" "IMPORT_ACCOUNTS" "DETACH_SOURCE" "ATTACH_SOURCE" "RESOLVE" "RESOLVE_ALL" "RESOLVE_OR_IGNORE" "API_KEY_RESET" "API_KEY_DELETE" "READ_STORAGE_CAPACITY_DATA" "DELETE_BOOKMARK" "UPDATE_BOOKMARK" "READ_BOOKMARK" "UPLOAD_MASKING_FILE" "GLOBAL_SYNC_ENGINES" "ADD_ENGINE_TO_HYPERSCALE" "CONFIGURE_CUSTOM_AUTO_TAGGING" "CONFIGURE_PREDEFINED_AUTO_TAGGING" "APPLY" "UNAPPLY" "UNDO_REFRESH" "CONVERT" "REPAIR_TIMEFLOW"
Example: permission=READ
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/vdbs/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": {
    }
}

Get a VDB by ID.

SecurityApiKeyAuth
Request
path Parameters
vdbId
required
string non-empty

The ID of the VDB.

Responses
200

OK

get/vdbs/{vdbId}
Response samples
application/json
{
  • "id": "vdb-123",
  • "database_type": "Oracle",
  • "name": "prod01-copy01",
  • "database_name": "prod01-copy01-dbname",
  • "namespace_id": "1-NAMESPACE-1",
  • "namespace_name": "test-engine-1",
  • "is_replica": true,
  • "is_locked": true,
  • "locked_by": 1,
  • "locked_by_name": "user-1",
  • "database_version": "10.2.0.5.0",
  • "jdbc_connection_string": "jdbc:oracle:thin:@(DESCRIPTION=(ENABLE=broken)(ADDRESS=(PROTOCOL=tcp)(HOST=10.43.47.94)(PORT=1521))(CONNECT_DATA=(UR=A)(SID=production01)))",
  • "size": 339292672,
  • "storage_size": 12345678,
  • "engine_id": "engine-123",
  • "status": "RUNNING",
  • "masked": false,
  • "content_type": "PDB",
  • "parent_timeflow_timestamp": "2021-05-01T08:51:34.148Z",
  • "parent_timeflow_timezone": "America/Los_Angeles",
  • "environment_id": "environment-123",
  • "ip_address": "192.0.2.0",
  • "fqdn": "virtual-dbs.myhost.com",
  • "parent_id": "vdb-122",
  • "parent_dsource_id": "dsource-id",
  • "root_parent_id": "vdb-121",
  • "group_name": "VDBs",
  • "engine_name": "engine-123-name",
  • "cdb_id": "cdb-123",
  • "tags": [
    ],
  • "creation_date": "2021-05-01T08:51:34.148Z",
  • "hooks": {
    },
  • "appdata_source_params": {
    },
  • "template_id": "DATABASE_TEMPLATE-1",
  • "config_params": {
    },
  • "additional_mount_points": [
    ],
  • "appdata_config_params": {
    },
  • "mount_point": "/var/mnt",
  • "current_timeflow_id": "timeflow-456",
  • "previous_timeflow_id": "timeflow-123",
  • "last_refreshed_date": "2023-04-15T02:11:14.248Z",
  • "vdb_restart": true,
  • "is_appdata": true,
  • "exported_data_directory": "domain0/oracle_db_container-30/oracle_timeflow-32/datafile",
  • "vcdb_exported_data_directory": "domain0/oracle_db_container-29/oracle_timeflow-31/datafile",
  • "toolkit_id": "toolkit-1",
  • "plugin_version": "1.0.0",
  • "primary_object_id": "1-CONTAINER-1",
  • "primary_engine_id": "1",
  • "primary_engine_name": "source-engine",
  • "replicas": [
    ],
  • "invoke_datapatch": true,
  • "enabled": true,
  • "node_listeners": [
    ],
  • "instance_name": "VDBSID",
  • "instance_number": 0,
  • "instances": [
    ],
  • "oracle_services": [
    ],
  • "repository_id": "1-ORACLE_INSTALL-1"
}

Update values of a VDB

SecurityApiKeyAuth
Request
path Parameters
vdbId
required
string non-empty

The ID of the VDB.

Request Body schema: application/json

The new data to update a VDB.

name
string [ 1 .. 256 ] characters

The unique name of the VDB within a group.

db_username
string [ 1 .. 256 ] characters

The username of the database user (Oracle, ASE Only).

db_password
string [ 1 .. 256 ] characters

The password of the database user (Oracle, ASE Only).

validate_db_credentials
boolean
Default: true

Whether db_username and db_password must be validated, if present, against the VDB. This must be set to false when credentials validation is not possible, for instance if the VDB is known to be disabled.

auto_restart
boolean

Whether to enable VDB restart.

environment_user_id
string [ 1 .. 256 ] characters

The environment user ID to use to connect to the target environment.

template_id
string [ 1 .. 256 ] characters

The ID of the target VDB Template (Oracle and MSSql Only).

listener_ids
Array of strings

The listener IDs for this provision operation (Oracle Only).

new_dbid
boolean

Whether to enable new DBID for Oracle

cdc_on_provision
boolean

Whether to enable CDC on provision for MSSql

pre_script
string [ 1 .. 1024 ] characters

Pre script for MSSql.

post_script
string [ 1 .. 1024 ] characters

Post script for MSSql.

object (VirtualDatasetHooks)

VDB operation hooks.

object

Environment variable to be set when the engine administers a VDB. See the Engine documentation for the list of allowed/denied environment variables and rules about substitution. Custom environment variables can only be updated while the VDB is disabled.

custom_env_files
Array of strings

Environment files to be sourced when the Engine administers a VDB. This path can be followed by parameters. Paths and parameters are separated by spaces. Custom environment variables can only be updated while the VDB is disabled.

Array of objects (OracleRacCustomEnvFile)

Environment files to be sourced when the Engine administers an Oracle RAC VDB. This path can be followed by parameters. Paths and parameters are separated by spaces. Custom environment variables can only be updated while the VDB is disabled.

Array of objects (OracleRacCustomEnvVar)

Environment variable to be set when the engine administers an Oracle RAC VDB. See the Engine documentation for the list of allowed/denied environment variables and rules about substitution. Custom environment variables can only be updated while the VDB is disabled.

parent_tde_keystore_path
string [ 1 .. 1024 ] characters

Path to a copy of the parent's Oracle transparent data encryption keystore on the target host. Required to provision from snapshots containing encrypted database files. (Oracle Multitenant Only)

parent_tde_keystore_password
string [ 1 .. 1024 ] characters

The password of the keystore specified in parentTdeKeystorePath. (Oracle Multitenant Only)

tde_key_identifier
string [ 1 .. 256 ] characters

ID of the key created by Delphix. (Oracle Multitenant Only)

target_vcdb_tde_keystore_path
string [ 1 .. 1024 ] characters

Path to the keystore of the target vCDB. (Oracle Multitenant Only)

cdb_tde_keystore_password
string [ 1 .. 1024 ] characters

The password for the Transparent Data Encryption keystore associated with the CDB. (Oracle Multitenant Only)

object

The JSON payload conforming to the DraftV4 schema based on the type of application data being manipulated.

Array of objects or null (AdditionalMountPoint)

Specifies additional locations on which to mount a subdirectory of an AppData container. Can only be updated while the VDB is disabled.

object or null

The parameters specified by the source config schema in the toolkit

object or null

Database configuration parameter overrides.

mount_point
string

Mount point for the VDB (AppData only), can only be updated while the VDB is disabled.

oracle_services
Array of strings

List of jdbc connection strings which are used to connect with the database.

Array of objects (OracleRACDatabaseInstance)

The instances of this RAC database.

invoke_datapatch
boolean

Indicates whether datapatch should be invoked.

Responses
200

OK

patch/vdbs/{vdbId}
Request samples
application/json
{
  • "name": "my-vdb",
  • "db_username": "db-username",
  • "db_password": "db-password",
  • "validate_db_credentials": true,
  • "auto_restart": true,
  • "environment_user_id": "environment-user-123",
  • "template_id": "template-123",
  • "listener_ids": [
    ],
  • "new_dbid": true,
  • "cdc_on_provision": true,
  • "pre_script": "string",
  • "post_script": "string",
  • "hooks": {
    },
  • "custom_env_vars": {
    },
  • "custom_env_files": [
    ],
  • "oracle_rac_custom_env_files": [
    ],
  • "oracle_rac_custom_env_vars": [
    ],
  • "parent_tde_keystore_path": "/foo/bar/tde",
  • "parent_tde_keystore_password": "password",
  • "tde_key_identifier": "tde-indentifier",
  • "target_vcdb_tde_keystore_path": "/foo/cdb/tde",
  • "cdb_tde_keystore_password": "cdb-password",
  • "appdata_source_params": {
    },
  • "additional_mount_points": [
    ],
  • "appdata_config_params": {
    },
  • "config_params": {
    },
  • "mount_point": "/var/mnt",
  • "oracle_services": [
    ],
  • "instances": [
    ],
  • "invoke_datapatch": true
}
Response samples
application/json
{
  • "job": {
    }
}

List Snapshots for a VDB.

SecurityApiKeyAuth
Request
path Parameters
vdbId
required
string non-empty

The ID of the VDB.

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.

Responses
200

OK

get/vdbs/{vdbId}/snapshots
Response samples
application/json
{
  • "items": [
    ],
  • "response_metadata": {
    }
}

Snapshot a VDB.

SecurityApiKeyAuth
Request
path Parameters
vdbId
required
string non-empty

The ID of the VDB.

Responses
200

VDB snapshot initiated.

post/vdbs/{vdbId}/snapshots
Response samples
application/json
{
  • "job": {
    }
}

List Bookmarks compatible with this VDB.

SecurityApiKeyAuth
Request
path Parameters
vdbId
required
string non-empty

The ID of the VDB.

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" "creation_date" "-creation_date" "vdb_ids" "-vdb_ids" "retention" "-retention" "expiration" "-expiration" "data_timestamp" "-data_timestamp" "timeflow_id" "-timeflow_id" "location" "-location" "vdb_group_name" "-vdb_group_name"
Example: sort=id
Responses
200

OK

get/vdbs/{vdbId}/bookmarks
Response samples
application/json
{
  • "items": [
    ],
  • "response_metadata": {
    }
}

Search Bookmarks compatible with this VDB.

SecurityApiKeyAuth
Request
path Parameters
vdbId
required
string non-empty

The ID of the VDB.

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" "creation_date" "-creation_date" "vdb_ids" "-vdb_ids" "retention" "-retention" "expiration" "-expiration" "data_timestamp" "-data_timestamp" "timeflow_id" "-timeflow_id" "location" "-location" "vdb_group_name" "-vdb_group_name"
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/vdbs/{vdbId}/bookmarks/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": {
    }
}

Get tags for a VDB.

SecurityApiKeyAuth
Request
path Parameters
vdbId
required
string non-empty

The ID of the VDB.

Responses
200

Ok

get/vdbs/{vdbId}/tags
Response samples
application/json
{
  • "tags": [
    ]
}

Create tags for a VDB.

SecurityApiKeyAuth
Request
path Parameters
vdbId
required
string non-empty

The ID of the VDB.

Request Body schema: application/json
required

Tags information for VDB.

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

Array of tags with key value pairs

Responses
201

Created

post/vdbs/{vdbId}/tags
Request samples
application/json
{
  • "tags": [
    ]
}
Response samples
application/json
{
  • "tags": [
    ]
}

Delete tags for a VDB.

SecurityApiKeyAuth
Request
path Parameters
vdbId
required
string non-empty

The ID of the VDB.

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/vdbs/{vdbId}/tags/delete
Request samples
application/json

Delete all tags for given object - No request body required

{ }

Start a VDB.

SecurityApiKeyAuth
Request
path Parameters
vdbId
required
string non-empty

The ID of the VDB.

Request Body schema: application/json
optional
instances
Array of integers

List of specific Oracle Virtual Database Instances to start.

Responses
200

VDB start initiated.

post/vdbs/{vdbId}/start
Request samples
application/json
{
  • "instances": [
    ]
}
Response samples
application/json
{
  • "job": {
    }
}

Stop a VDB.

SecurityApiKeyAuth
Request
path Parameters
vdbId
required
string non-empty

The ID of the VDB.

Request Body schema: application/json
optional
instances
Array of integers

List of specific Oracle Virtual Database Instances to stop.

abort
boolean
Default: false

Whether to issue 'shutdown abort' to shutdown Oracle Virtual DB instances.

Responses
200

VDB stop initiated.

post/vdbs/{vdbId}/stop
Request samples
application/json
{
  • "instances": [
    ],
  • "abort": false
}
Response samples
application/json
{
  • "job": {
    }
}

Enable a VDB.

SecurityApiKeyAuth
Request
path Parameters
vdbId
required
string non-empty

The ID of the VDB.

Request Body schema: application/json

The parameters to enable a VDB.

attempt_start
boolean
Default: true

Whether to attempt a startup of the VDB after the enable.

Responses
200

VDB enable initiated.

post/vdbs/{vdbId}/enable
Request samples
application/json
{
  • "attempt_start": true
}
Response samples
application/json
{
  • "job": {
    }
}

Disable a VDB.

SecurityApiKeyAuth
Request
path Parameters
vdbId
required
string non-empty

The ID of the VDB.

Request Body schema: application/json

The parameters to disable a VDB.

attempt_cleanup
boolean
Default: true

Whether to attempt a cleanup of the VDB before the disable.

Responses
200

VDB disable initiated.

post/vdbs/{vdbId}/disable
Request samples
application/json
{
  • "attempt_cleanup": true
}
Response samples
application/json
{
  • "job": {
    }
}

Lock a VDB.

SecurityApiKeyAuth
Request
path Parameters
vdbId
required
string non-empty

The ID of the VDB.

Request Body schema: application/json
required

The parameters to lock a VDB.

account_id
integer <int64>

Id of the account on whose behalf this request is being made. Only accounts having LOCK_FOR_OTHER_ACCOUNT permission can lock VDBs on behalf of other accounts. If this property is not specified then the account id of the authenticated user making the request is used.

Responses
200

VDB is locked.

post/vdbs/{vdbId}/lock
Request samples
application/json
{
  • "account_id": 0
}
Response samples
application/json
{
  • "id": "vdb-123",
  • "database_type": "Oracle",
  • "name": "prod01-copy01",
  • "database_name": "prod01-copy01-dbname",
  • "namespace_id": "1-NAMESPACE-1",
  • "namespace_name": "test-engine-1",
  • "is_replica": true,
  • "is_locked": true,
  • "locked_by": 1,
  • "locked_by_name": "user-1",
  • "database_version": "10.2.0.5.0",
  • "jdbc_connection_string": "jdbc:oracle:thin:@(DESCRIPTION=(ENABLE=broken)(ADDRESS=(PROTOCOL=tcp)(HOST=10.43.47.94)(PORT=1521))(CONNECT_DATA=(UR=A)(SID=production01)))",
  • "size": 339292672,
  • "storage_size": 12345678,
  • "engine_id": "engine-123",
  • "status": "RUNNING",
  • "masked": false,
  • "content_type": "PDB",
  • "parent_timeflow_timestamp": "2021-05-01T08:51:34.148Z",
  • "parent_timeflow_timezone": "America/Los_Angeles",
  • "environment_id": "environment-123",
  • "ip_address": "192.0.2.0",
  • "fqdn": "virtual-dbs.myhost.com",
  • "parent_id": "vdb-122",
  • "parent_dsource_id": "dsource-id",
  • "root_parent_id": "vdb-121",
  • "group_name": "VDBs",
  • "engine_name": "engine-123-name",
  • "cdb_id": "cdb-123",
  • "tags": [
    ],
  • "creation_date": "2021-05-01T08:51:34.148Z",
  • "hooks": {
    },
  • "appdata_source_params": {
    },
  • "template_id": "DATABASE_TEMPLATE-1",
  • "config_params": {
    },
  • "additional_mount_points": [
    ],
  • "appdata_config_params": {
    },
  • "mount_point": "/var/mnt",
  • "current_timeflow_id": "timeflow-456",
  • "previous_timeflow_id": "timeflow-123",
  • "last_refreshed_date": "2023-04-15T02:11:14.248Z",
  • "vdb_restart": true,
  • "is_appdata": true,
  • "exported_data_directory": "domain0/oracle_db_container-30/oracle_timeflow-32/datafile",
  • "vcdb_exported_data_directory": "domain0/oracle_db_container-29/oracle_timeflow-31/datafile",
  • "toolkit_id": "toolkit-1",
  • "plugin_version": "1.0.0",
  • "primary_object_id": "1-CONTAINER-1",
  • "primary_engine_id": "1",
  • "primary_engine_name": "source-engine",
  • "replicas": [
    ],
  • "invoke_datapatch": true,
  • "enabled": true,
  • "node_listeners": [
    ],
  • "instance_name": "VDBSID",
  • "instance_number": 0,
  • "instances": [
    ],
  • "oracle_services": [
    ],
  • "repository_id": "1-ORACLE_INSTALL-1"
}

Unlock a VDB.

SecurityApiKeyAuth
Request
path Parameters
vdbId
required
string non-empty

The ID of the VDB.

Responses
200

VDB is unlocked.

post/vdbs/{vdbId}/unlock
Response samples
application/json
{
  • "id": "vdb-123",
  • "database_type": "Oracle",
  • "name": "prod01-copy01",
  • "database_name": "prod01-copy01-dbname",
  • "namespace_id": "1-NAMESPACE-1",
  • "namespace_name": "test-engine-1",
  • "is_replica": true,
  • "is_locked": true,
  • "locked_by": 1,
  • "locked_by_name": "user-1",
  • "database_version": "10.2.0.5.0",
  • "jdbc_connection_string": "jdbc:oracle:thin:@(DESCRIPTION=(ENABLE=broken)(ADDRESS=(PROTOCOL=tcp)(HOST=10.43.47.94)(PORT=1521))(CONNECT_DATA=(UR=A)(SID=production01)))",
  • "size": 339292672,
  • "storage_size": 12345678,
  • "engine_id": "engine-123",
  • "status": "RUNNING",
  • "masked": false,
  • "content_type": "PDB",
  • "parent_timeflow_timestamp": "2021-05-01T08:51:34.148Z",
  • "parent_timeflow_timezone": "America/Los_Angeles",
  • "environment_id": "environment-123",
  • "ip_address": "192.0.2.0",
  • "fqdn": "virtual-dbs.myhost.com",
  • "parent_id": "vdb-122",
  • "parent_dsource_id": "dsource-id",
  • "root_parent_id": "vdb-121",
  • "group_name": "VDBs",
  • "engine_name": "engine-123-name",
  • "cdb_id": "cdb-123",
  • "tags": [
    ],
  • "creation_date": "2021-05-01T08:51:34.148Z",
  • "hooks": {
    },
  • "appdata_source_params": {
    },
  • "template_id": "DATABASE_TEMPLATE-1",
  • "config_params": {
    },
  • "additional_mount_points": [
    ],
  • "appdata_config_params": {
    },
  • "mount_point": "/var/mnt",
  • "current_timeflow_id": "timeflow-456",
  • "previous_timeflow_id": "timeflow-123",
  • "last_refreshed_date": "2023-04-15T02:11:14.248Z",
  • "vdb_restart": true,
  • "is_appdata": true,
  • "exported_data_directory": "domain0/oracle_db_container-30/oracle_timeflow-32/datafile",
  • "vcdb_exported_data_directory": "domain0/oracle_db_container-29/oracle_timeflow-31/datafile",
  • "toolkit_id": "toolkit-1",
  • "plugin_version": "1.0.0",
  • "primary_object_id": "1-CONTAINER-1",
  • "primary_engine_id": "1",
  • "primary_engine_name": "source-engine",
  • "replicas": [
    ],
  • "invoke_datapatch": true,
  • "enabled": true,
  • "node_listeners": [
    ],
  • "instance_name": "VDBSID",
  • "instance_number": 0,
  • "instances": [
    ],
  • "oracle_services": [
    ],
  • "repository_id": "1-ORACLE_INSTALL-1"
}

Delete a VDB.

SecurityApiKeyAuth
Request
path Parameters
vdbId
required
string non-empty

The ID of the VDB.

Request Body schema: application/json

The parameters to delete a VDB.

force
boolean
Default: false

Whether to continue the operation upon failures.

Responses
200

VDB delete initiated.

post/vdbs/{vdbId}/delete
Request samples
application/json
{
  • "force": false
}
Response samples
application/json
{
  • "job": {
    }
}

Rollback a VDB by timestamp.Deprecated

SecurityApiKeyAuth
Request
path Parameters
vdbId
required
string non-empty

The ID of the VDB.

Request Body schema: application/json

The parameters to rollback a VDB.

timestamp
string <date-time>

The point in time from which to execute the operation. Mutually exclusive with timestamp_in_database_timezone. If the timestamp is not set, selects the latest point.

timestamp_in_database_timezone
string[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:...

The point in time from which to execute the operation, expressed as a date-time in the timezone of the source database. Mutually exclusive with timestamp.

timeflow_id
string

The Timeflow ID.

Responses
200

VDB rollback initiated.

post/vdbs/{vdbId}/rollback_by_timestamp
Request samples
application/json
{
  • "timestamp": "2021-05-01T08:51:34.148Z",
  • "timestamp_in_database_timezone": "2021-08-14T14:55:20.507Z",
  • "timeflow_id": "timeflow-123"
}
Response samples
application/json
{
  • "job": {
    }
}

Rollback a VDB by snapshot.Deprecated

SecurityApiKeyAuth
Request
path Parameters
vdbId
required
string non-empty

The ID of the VDB.

Request Body schema: application/json

The parameters to rollback a VDB.

snapshot_id
string [ 1 .. 256 ] characters

The ID of the snapshot from which to execute the operation. If the snapshot_id is not, selects the latest snapshot.

Responses
200

VDB rollback initiated.

post/vdbs/{vdbId}/rollback_by_snapshot
Request samples
application/json
{
  • "snapshot_id": "string"
}
Response samples
application/json
{
  • "job": {
    }
}

Rollback a VDB from a bookmark with only the same VDB.Deprecated

SecurityApiKeyAuth
Request
path Parameters
vdbId
required
string non-empty

The ID of the VDB.

Request Body schema: application/json

The parameters to rollback a VDB.

bookmark_id
required
string [ 1 .. 256 ] characters

The ID of the bookmark from which to execute the operation. The bookmark must contain only one VDB.

Responses
200

VDB rollback initiated.

post/vdbs/{vdbId}/rollback_from_bookmark
Request samples
application/json
{
  • "bookmark_id": "string"
}
Response samples
application/json
{
  • "job": {
    }
}

Refresh a VDB by timestamp.

SecurityApiKeyAuth
Request
path Parameters
vdbId
required
string non-empty

The ID of the VDB.

Request Body schema: application/json

The parameters to refresh a VDB.

timestamp
string <date-time>

The point in time from which to execute the operation. Mutually exclusive with timestamp_in_database_timezone. If the timestamp is not set, selects the latest point.

timestamp_in_database_timezone
string[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:...

The point in time from which to execute the operation, expressed as a date-time in the timezone of the source database. Mutually exclusive with timestamp.

timeflow_id
string [ 1 .. 256 ] characters

The Timeflow ID.

dataset_id
string [ 1 .. 256 ] characters

ID of the dataset to refresh to, mutually exclusive with timeflow_id.

Responses
200

VDB refresh initiated.

post/vdbs/{vdbId}/refresh_by_timestamp
Request samples
application/json
{
  • "timestamp": "2021-05-01T08:51:34.148Z",
  • "timestamp_in_database_timezone": "2021-08-14T14:55:20.507Z",
  • "timeflow_id": "timeflow_123",
  • "dataset_id": "123-CONTAINER_1"
}
Response samples
application/json
{
  • "job": {
    }
}

Refresh a VDB by snapshot.

SecurityApiKeyAuth
Request
path Parameters
vdbId
required
string non-empty

The ID of the VDB.

Request Body schema: application/json

The parameters to refresh a VDB.

snapshot_id
string [ 1 .. 256 ] characters

The ID of the snapshot from which to execute the operation. If the snapshot_id is not, selects the latest snapshot.

Responses
200

VDB refresh initiated.

post/vdbs/{vdbId}/refresh_by_snapshot
Request samples
application/json
{
  • "snapshot_id": "string"
}
Response samples
application/json
{
  • "job": {
    }
}

Refresh a VDB from bookmark with a single VDB.

SecurityApiKeyAuth
Request
path Parameters
vdbId
required
string non-empty

The ID of the VDB.

Request Body schema: application/json

The parameters to refresh a VDB.

bookmark_id
required
string [ 1 .. 256 ] characters

The ID of the bookmark from which to execute the operation. The bookmark must contain only one VDB.

Responses
200

VDB refresh initiated.

post/vdbs/{vdbId}/refresh_from_bookmark
Request samples
application/json
{
  • "bookmark_id": "string"
}
Response samples
application/json
{
  • "job": {
    }
}

Refresh a VDB by location.

SecurityApiKeyAuth
Request
path Parameters
vdbId
required
string non-empty

The ID of the VDB.

Request Body schema: application/json

The parameters to refresh a VDB.

location
string [ 1 .. 256 ] characters

The database specific identifier for tracking transactions (SCN, LSN, etc).

dataset_id
string [ 1 .. 256 ] characters

ID of the dataset to refresh to, mutually exclusive with timeflow_id.

timeflow_id
string [ 1 .. 256 ] characters

ID of the timeflow to refresh to, mutually exclusive with dataset_id.

Responses
200

VDB refresh initiated.

post/vdbs/{vdbId}/refresh_by_location
Request samples
application/json
{
  • "location": "1234567",
  • "dataset_id": "123-CONTAINER_1",
  • "timeflow_id": "timeflow_123"
}
Response samples
application/json
{
  • "job": {
    }
}

Undo the last refresh operation.

SecurityApiKeyAuth
Request
path Parameters
vdbId
required
string non-empty

The ID of the VDB.

Responses
200

VDB undo refresh initiated.

post/vdbs/{vdbId}/undo_refresh
Response samples
application/json
{
  • "job": {
    }
}

Switches the current timeflow of a VDB.

SecurityApiKeyAuth
Request
path Parameters
vdbId
required
string non-empty

The ID of the VDB.

Request Body schema: application/json

The parameters to switch the timeflow of a VDB.

timeflow_id
string

The ID of the timeflow to switch to.

Responses
200

Switch timeflow initiated.

post/vdbs/{vdbId}/switch_timeflow
Request samples
application/json
{
  • "timeflow_id": "timeflow-123"
}
Response samples
application/json
{
  • "job": {
    }
}

Upgrade Oracle VDB

SecurityApiKeyAuth
Request
path Parameters
vdbId
required
string non-empty

The ID of the VDB.

Request Body schema: application/json

The new API to upgrade Oracle VDB

repository_id
required
string

The id of the dSource/VDB repository to upgrade to.

environment_user_id
required
string

Reference of the environment user to use for dSource/VDB upgrade.

Responses
200

OK

post/vdbs/oracle/{vdbId}/upgrade
Request samples
application/json
{
  • "repository_id": "1-ORACLE_INSTALL-4",
  • "environment_user_id": "HOST_USER-4"
}
Response samples
application/json
{
  • "job": {
    }
}

Provision a new VDB by timestamp.

SecurityApiKeyAuth
Request
Request Body schema: application/json
required

The parameters to provision a VDB.

Array of objects (Hook) <= 100 items

The commands to execute on the target environment before refreshing the VDB.

Array of objects (Hook) <= 100 items

The commands to execute on the target environment after refreshing the VDB.

Array of objects (Hook) <= 100 items

The commands to execute on the target environment before refreshing the VDB with data from itself.

Array of objects (Hook) <= 100 items

The commands to execute on the target environment after refreshing the VDB with data from itself.

Array of objects (Hook) <= 100 items
Deprecated

The commands to execute on the target environment before rewinding the VDB.

Array of objects (Hook) <= 100 items
Deprecated

The commands to execute on the target environment after rewinding the VDB.

Array of objects (Hook) <= 100 items

The commands to execute on the target environment when the VDB is created or refreshed.

Array of objects (Hook) <= 100 items

The commands to execute on the target environment before snapshotting a virtual source. These commands can quiesce any data prior to snapshotting.

Array of objects (Hook) <= 100 items

The commands to execute on the target environment after snapshotting a virtual source.

Array of objects (Hook) <= 100 items

The commands to execute on the target environment before starting a virtual source.

Array of objects (Hook) <= 100 items

The commands to execute on the target environment after starting a virtual source.

Array of objects (Hook) <= 100 items

The commands to execute on the target environment before stopping a virtual source.

Array of objects (Hook) <= 100 items

The commands to execute on the target environment after stopping a virtual source.

target_group_id
string [ 1 .. 256 ] characters

The ID of the group into which the VDB will be provisioned. If unset, a group is selected randomly on the Engine.

name
string [ 1 .. 256 ] characters

The unique name of the provisioned VDB within a group. If unset, a name is randomly generated.

database_name
string [ 1 .. 256 ] characters

The name of the database on the target environment. Defaults to the value of the name property.

cdb_id
string [ 1 .. 256 ] characters

The ID of the container database (CDB) to provision an Oracle Multitenant database into. This corresponds to a CDB or VCDB API object. When this is not set, a new vCDB will be provisioned.

cluster_node_ids
Array of strings non-empty

The cluster node ids, name or addresses for this provision operation (Oracle RAC Only).

Array of objects (ClusterNodeInstance) non-empty

The cluster node instances details for this provision operation(Oracle RAC Only).This property is mutually exclusive with cluster_node_ids.

truncate_log_on_checkpoint
boolean

Whether to truncate log on checkpoint (ASE only).

os_username
string [ 1 .. 256 ] characters

The name of the privileged user to run the provision operation (Oracle Only).

os_password
string [ 1 .. 256 ] characters

The password of the privileged user to run the provision operation (Oracle Only).

environment_id
string [ 1 .. 256 ] characters

The ID of the target environment where to provision the VDB. If repository_id unambigously identifies a repository, this is unnecessary and ignored. Otherwise, a compatible repository is randomly selected on the environment.

environment_user_id
string [ 1 .. 256 ] characters

The environment user ID to use to connect to the target environment.

repository_id
string [ 1 .. 256 ] characters

The ID of the target repository where to provision the VDB. A repository typically corresponds to a database installation (Oracle home, database instance, ...). Setting this attribute implicitly determines the environment where to provision the VDB.

auto_select_repository
boolean

Option to automatically select a compatible environment and repository. Mutually exclusive with repository_id.

vdb_restart
boolean

Indicates whether the Engine should automatically restart this virtual source when target host reboot is detected.

template_id
string [ 1 .. 256 ] characters

The ID of the target VDB Template (Oracle and MSSql Only).

auxiliary_template_id
string [ 1 .. 256 ] characters

The ID of the configuration template to apply to the auxiliary container database. This is only relevant when provisioning a Multitenant pluggable database into an existing CDB, i.e when the cdb_id property is set.(Oracle Only)

file_mapping_rules
string [ 1 .. 131072 ] characters

Target VDB file mapping rules (Oracle Only). Rules must be line separated (\n or \r) and each line must have the format "pattern:replacement". Lines are applied in order.

oracle_instance_name
string [ 1 .. 15 ] characters ^[a-zA-Z0-9_]+$

Target VDB SID name (Oracle Only).

unique_name
string [ 1 .. 30 ] characters ^[a-zA-Z0-9_\$#]+$

Target VDB db_unique_name (Oracle Only).

vcdb_name
string [ 1 .. 256 ] characters ^[a-zA-Z0-9_]+$

When provisioning an Oracle Multitenant vCDB (when the cdb_id property is not set), the name of the provisioned vCDB (Oracle Multitenant Only).

vcdb_database_name
string [ 1 .. 8 ] characters

When provisioning an Oracle Multitenant vCDB (when the cdb_id property is not set), the database name of the provisioned vCDB. Defaults to the value of the vcdb_name property. (Oracle Multitenant Only).

mount_point
string [ 1 .. 256 ] characters

Mount point for the VDB (Oracle, ASE, AppData).

open_reset_logs
boolean

Whether to open the database after provision (Oracle Only).

snapshot_policy_id
string [ 1 .. 256 ] characters

The ID of the snapshot policy for the VDB.

retention_policy_id
string [ 1 .. 256 ] characters

The ID of the retention policy for the VDB.

recovery_model
string

Recovery model of the source database (MSSql Only).

Enum: "FULL" "SIMPLE" "BULK_LOGGED"
pre_script
string [ 1 .. 1024 ] characters

PowerShell script or executable to run prior to provisioning (MSSql Only).

post_script
string [ 1 .. 1024 ] characters

PowerShell script or executable to run after provisioning (MSSql Only).

cdc_on_provision
boolean

Option to enable change data capture (CDC) on both the provisioned VDB and subsequent snapshot-related operations (e.g. refresh, rewind) (MSSql Only).

online_log_size
integer >= 4

Online log size in MB (Oracle Only).

online_log_groups
integer >= 2

Number of online log groups (Oracle Only).

archive_log
boolean

Option to create a VDB in archivelog mode (Oracle Only).

new_dbid
boolean

Option to generate a new DB ID for the created VDB (Oracle Only).

masked
boolean

Indicates whether to mark this VDB as a masked VDB.

listener_ids
Array of strings

The listener IDs for this provision operation (Oracle Only).

object

Environment variable to be set when the engine creates a VDB. See the Engine documentation for the list of allowed/denied environment variables and rules about substitution.

custom_env_files
Array of strings

Environment files to be sourced when the Engine creates a VDB. This path can be followed by parameters. Paths and parameters are separated by spaces.

Array of objects (OracleRacCustomEnvFile)

Environment files to be sourced when the Engine creates an Oracle RAC VDB. This path can be followed by parameters. Paths and parameters are separated by spaces.

Array of objects (OracleRacCustomEnvVar)

Environment variable to be set when the engine creates an Oracle RAC VDB. See the Engine documentation for the list of allowed/denied environment variables and rules about substitution.

parentTdeKeystorePath
string [ 1 .. 1024 ] characters

Path to a copy of the parent's Oracle transparent data encryption keystore on the target host. Required to provision from snapshots containing encrypted database files. (Oracle Multitenant Only)

parent_tde_keystore_password
string [ 1 .. 1024 ] characters

The password of the keystore specified in parentTdeKeystorePath. (Oracle Multitenant Only)

tde_exported_key_file_secret
string [ 1 .. 1024 ] characters

Secret to be used while exporting and importing vPDB encryption keys if Transparent Data Encryption is enabled on the vPDB. (Oracle Multitenant Only)

tde_key_identifier
string [ 1 .. 256 ] characters

ID of the key created by Delphix. (Oracle Multitenant Only)

target_vcdb_tde_keystore_path
string [ 1 .. 1024 ] characters

Path to the keystore of the target vCDB. (Oracle Multitenant Only)

cdb_tde_keystore_password
string [ 1 .. 1024 ] characters

The password for the Transparent Data Encryption keystore associated with the CDB. (Oracle Multitenant Only)

vcdb_tde_key_identifier
string [ 1 .. 256 ] characters

ID of the key created by Delphix. (Oracle Multitenant Only)

object

The JSON payload conforming to the DraftV4 schema based on the type of application data being manipulated.

Array of objects or null (AdditionalMountPoint)

Specifies additional locations on which to mount a subdirectory of an AppData container.

object or null

The list of parameters specified by the source config schema in the toolkit

object or null

Database configuration parameter overrides.

privileged_os_user
string <= 32 characters ^$|^[a-zA-Z_][a-zA-Z0-9_\-]+[$]?$

This privileged unix username will be used to create the VDB. Leave this field blank if you do not want to use privilege elevation. The unix privileged username should begin with a letter or an underscore, followed by letters, digits, underscores, or dashes. They can end with a dollar sign (postgres only).

postgres_port
integer [ 1 .. 65536 ]

Port number for Postgres target database (postgres only).

Array of objects (ConfigSettingsStg)

Custom Database-Level config settings (postgres only).

vcdb_restart
boolean

Indicates whether the Engine should automatically restart this vCDB when target host reboot is detected. If vdb_restart property value is not explicitly set and vcdb_restart is set as false - the vdb_restart property is defaulted to false.

mssql_failover_drive_letter
string = 1 characters

Base drive letter location for mount points. (MSSql Only).

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

The tags to be created for VDB.

invoke_datapatch
boolean

Whether to invoke datapatch during provisioning (Oracle Only).

timestamp
string <date-time>

The point in time from which to execute the operation. Mutually exclusive with timestamp_in_database_timezone. If the timestamp is not set, selects the latest point.

timestamp_in_database_timezone
string[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:...

The point in time from which to execute the operation, expressed as a date-time in the timezone of the source database. Mutually exclusive with timestamp.

timeflow_id
string

The Timeflow ID.

engine_id
string [ 1 .. 256 ] characters

The ID of the Engine onto which to provision. If the source ID unambiguously identifies a source object, this parameter is unnecessary and ignored.

source_data_id
required
string [ 1 .. 256 ] characters

The ID of the source object (dSource or VDB) to provision from. All other objects referenced by the parameters must live on the same engine as the source.

make_current_account_owner
boolean
Default: true

Whether the account provisioning this VDB must be configured as owner of the VDB.

Responses
200

VDB provisioning initiated.

post/vdbs/provision_by_timestamp
Request samples
application/json
{
  • "pre_refresh": [
    ],
  • "post_refresh": [
    ],
  • "pre_self_refresh": [
    ],
  • "post_self_refresh": [
    ],
  • "pre_rollback": [
    ],
  • "post_rollback": [
    ],
  • "configure_clone": [
    ],
  • "pre_snapshot": [
    ],
  • "post_snapshot": [
    ],
  • "pre_start": [
    ],
  • "post_start": [
    ],
  • "pre_stop": [
    ],
  • "post_stop": [
    ],
  • "target_group_id": "group-123",
  • "name": "my-test-vdb",
  • "database_name": "my-test-database",
  • "cdb_id": "ORACLE_SINGLE_CONFIG-376",
  • "cluster_node_ids": [
    ],
  • "cluster_node_instances": [
    ],
  • "truncate_log_on_checkpoint": true,
  • "os_username": "os-user-x",
  • "os_password": "os-user-secret-password",
  • "environment_id": "environment-123",
  • "environment_user_id": "environment-user-123",
  • "repository_id": "oracle-home-123",
  • "auto_select_repository": true,
  • "vdb_restart": true,
  • "template_id": "template-123",
  • "auxiliary_template_id": "aux-template-123",
  • "file_mapping_rules": "/datafile/dbdhcp3/oradata/dbdhcp3:/data\n/u03/app/ora11202/product/11.2.0/dbhome_1/dbs/dbv_R2V4.dbf:/data/dbv_R2V4.dbf",
  • "oracle_instance_name": "dbdhcp2",
  • "unique_name": "dbdhcp2",
  • "vcdb_name": "VCCD_6QQ",
  • "vcdb_database_name": "VCCD_6QQ",
  • "mount_point": "/var/mnt",
  • "open_reset_logs": true,
  • "snapshot_policy_id": "snapshot-123",
  • "retention_policy_id": "retention-policy-123",
  • "recovery_model": "FULL",
  • "pre_script": "C:\\Program Files\\Delphix\\scripts\\myscript.ps1",
  • "post_script": "C:\\Program Files\\Delphix\\scripts\\myscript.ps1",
  • "cdc_on_provision": true,
  • "online_log_size": 4,
  • "online_log_groups": 2,
  • "archive_log": true,
  • "new_dbid": true,
  • "masked": true,
  • "listener_ids": [
    ],
  • "custom_env_vars": {
    },
  • "custom_env_files": [
    ],
  • "oracle_rac_custom_env_files": [
    ],
  • "oracle_rac_custom_env_vars": [
    ],
  • "parentTdeKeystorePath": "/foo/bar/tde",
  • "parent_tde_keystore_password": "password",
  • "tde_exported_key_file_secret": "secret",
  • "tde_key_identifier": "tde-indentifier",
  • "target_vcdb_tde_keystore_path": "/foo/cdb/tde",
  • "cdb_tde_keystore_password": "cdb-password",
  • "vcdb_tde_key_identifier": "vcdb-identifier",
  • "appdata_source_params": {
    },
  • "additional_mount_points": [
    ],
  • "appdata_config_params": {
    },
  • "config_params": {
    },
  • "privileged_os_user": "string",
  • "postgres_port": 1,
  • "config_settings_stg": [
    ],
  • "vcdb_restart": true,
  • "mssql_failover_drive_letter": "s",
  • "tags": [
    ],
  • "invoke_datapatch": false,
  • "timestamp": "2021-05-01T08:51:34.148Z",
  • "timestamp_in_database_timezone": "2021-08-14T14:55:20.507Z",
  • "timeflow_id": "timeflow-123",
  • "engine_id": "engine-123",
  • "source_data_id": "source-123",
  • "make_current_account_owner": true
}
Response samples
application/json
{
  • "job": {
    },
  • "vdb_id": "string"
}

Get default provision parameters for provisioning a new VDB by timestamp.

SecurityApiKeyAuth
Request
Request Body schema: application/json
required

The request to get default VDB provision parameters for provisioning a new VDB by timestamp.

timestamp
string <date-time>

The point in time from which to execute the operation. Mutually exclusive with timestamp_in_database_timezone. If the timestamp is not set, selects the latest point.

timestamp_in_database_timezone
string[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:...

The point in time from which to execute the operation, expressed as a date-time in the timezone of the source database. Mutually exclusive with timestamp.

engine_id
string [ 1 .. 256 ] characters

The ID of the Engine onto which to provision. If the source ID unambiguously identifies a source object, this parameter is unnecessary and ignored.

source_data_id
required
string [ 1 .. 256 ] characters

The ID of the source object (dSource or VDB) to provision from. All other objects referenced by the parameters must live on the same engine as the source.

timeflow_id
string

The Timeflow ID.

Responses
200

Default VDB provisioning parameters.

post/vdbs/provision_by_timestamp/defaults
Request samples
application/json
{
  • "timestamp": "2021-05-01T08:51:34.148Z",
  • "timestamp_in_database_timezone": "2021-08-14T14:55:20.507Z",
  • "engine_id": "engine-123",
  • "source_data_id": "source-123",
  • "timeflow_id": "timeflow-123"
}
Response samples
application/json
{
  • "pre_refresh": [
    ],
  • "post_refresh": [
    ],
  • "pre_self_refresh": [
    ],
  • "post_self_refresh": [
    ],
  • "pre_rollback": [
    ],
  • "post_rollback": [
    ],
  • "configure_clone": [
    ],
  • "pre_snapshot": [
    ],
  • "post_snapshot": [
    ],
  • "pre_start": [
    ],
  • "post_start": [
    ],
  • "pre_stop": [
    ],
  • "post_stop": [
    ],
  • "target_group_id": "group-123",
  • "name": "my-test-vdb",
  • "database_name": "my-test-database",
  • "cdb_id": "ORACLE_SINGLE_CONFIG-376",
  • "cluster_node_ids": [
    ],
  • "cluster_node_instances": [
    ],
  • "truncate_log_on_checkpoint": true,
  • "os_username": "os-user-x",
  • "os_password": "os-user-secret-password",
  • "environment_id": "environment-123",
  • "environment_user_id": "environment-user-123",
  • "repository_id": "oracle-home-123",
  • "auto_select_repository": true,
  • "vdb_restart": true,
  • "template_id": "template-123",
  • "auxiliary_template_id": "aux-template-123",
  • "file_mapping_rules": "/datafile/dbdhcp3/oradata/dbdhcp3:/data\n/u03/app/ora11202/product/11.2.0/dbhome_1/dbs/dbv_R2V4.dbf:/data/dbv_R2V4.dbf",
  • "oracle_instance_name": "dbdhcp2",
  • "unique_name": "dbdhcp2",
  • "vcdb_name": "VCCD_6QQ",
  • "vcdb_database_name": "VCCD_6QQ",
  • "mount_point": "/var/mnt",
  • "open_reset_logs": true,
  • "snapshot_policy_id": "snapshot-123",
  • "retention_policy_id": "retention-policy-123",
  • "recovery_model": "FULL",
  • "pre_script": "C:\\Program Files\\Delphix\\scripts\\myscript.ps1",
  • "post_script": "C:\\Program Files\\Delphix\\scripts\\myscript.ps1",
  • "cdc_on_provision": true,
  • "online_log_size": 4,
  • "online_log_groups": 2,
  • "archive_log": true,
  • "new_dbid": true,
  • "masked": true,
  • "listener_ids": [
    ],
  • "custom_env_vars": {
    },
  • "custom_env_files": [
    ],
  • "oracle_rac_custom_env_files": [
    ],
  • "oracle_rac_custom_env_vars": [
    ],
  • "parentTdeKeystorePath": "/foo/bar/tde",
  • "parent_tde_keystore_password": "password",
  • "tde_exported_key_file_secret": "secret",
  • "tde_key_identifier": "tde-indentifier",
  • "target_vcdb_tde_keystore_path": "/foo/cdb/tde",
  • "cdb_tde_keystore_password": "cdb-password",
  • "vcdb_tde_key_identifier": "vcdb-identifier",
  • "appdata_source_params": {
    },
  • "additional_mount_points": [
    ],
  • "appdata_config_params": {
    },
  • "config_params": {
    },
  • "privileged_os_user": "string",
  • "postgres_port": 1,
  • "config_settings_stg": [
    ],
  • "vcdb_restart": true,
  • "mssql_failover_drive_letter": "s",
  • "tags": [
    ],
  • "invoke_datapatch": false,
  • "timestamp": "2021-05-01T08:51:34.148Z",
  • "timestamp_in_database_timezone": "2021-08-14T14:55:20.507Z",
  • "timeflow_id": "timeflow-123",
  • "engine_id": "engine-123",
  • "source_data_id": "source-123",
  • "make_current_account_owner": true
}

Provision a new VDB by location.

SecurityApiKeyAuth
Request
Request Body schema: application/json
required

The parameters to provision a VDB.

Array of objects (Hook) <= 100 items

The commands to execute on the target environment before refreshing the VDB.

Array of objects (Hook) <= 100 items

The commands to execute on the target environment after refreshing the VDB.

Array of objects (Hook) <= 100 items

The commands to execute on the target environment before refreshing the VDB with data from itself.

Array of objects (Hook) <= 100 items

The commands to execute on the target environment after refreshing the VDB with data from itself.

Array of objects (Hook) <= 100 items
Deprecated

The commands to execute on the target environment before rewinding the VDB.

Array of objects (Hook) <= 100 items
Deprecated

The commands to execute on the target environment after rewinding the VDB.

Array of objects (Hook) <= 100 items

The commands to execute on the target environment when the VDB is created or refreshed.

Array of objects (Hook) <= 100 items

The commands to execute on the target environment before snapshotting a virtual source. These commands can quiesce any data prior to snapshotting.

Array of objects (Hook) <= 100 items

The commands to execute on the target environment after snapshotting a virtual source.

Array of objects (Hook) <= 100 items

The commands to execute on the target environment before starting a virtual source.

Array of objects (Hook) <= 100 items

The commands to execute on the target environment after starting a virtual source.

Array of objects (Hook) <= 100 items

The commands to execute on the target environment before stopping a virtual source.

Array of objects (Hook) <= 100 items

The commands to execute on the target environment after stopping a virtual source.

target_group_id
string [ 1 .. 256 ] characters

The ID of the group into which the VDB will be provisioned. If unset, a group is selected randomly on the Engine.

name
string [ 1 .. 256 ] characters

The unique name of the provisioned VDB within a group. If unset, a name is randomly generated.

database_name
string [ 1 .. 256 ] characters

The name of the database on the target environment. Defaults to the value of the name property.

cdb_id
string [ 1 .. 256 ] characters

The ID of the container database (CDB) to provision an Oracle Multitenant database into. This corresponds to a CDB or VCDB API object. When this is not set, a new vCDB will be provisioned.

cluster_node_ids
Array of strings non-empty

The cluster node ids, name or addresses for this provision operation (Oracle RAC Only).

Array of objects (ClusterNodeInstance) non-empty

The cluster node instances details for this provision operation(Oracle RAC Only).This property is mutually exclusive with cluster_node_ids.

truncate_log_on_checkpoint
boolean

Whether to truncate log on checkpoint (ASE only).

os_username
string [ 1 .. 256 ] characters

The name of the privileged user to run the provision operation (Oracle Only).

os_password
string [ 1 .. 256 ] characters

The password of the privileged user to run the provision operation (Oracle Only).

environment_id
string [ 1 .. 256 ] characters

The ID of the target environment where to provision the VDB. If repository_id unambigously identifies a repository, this is unnecessary and ignored. Otherwise, a compatible repository is randomly selected on the environment.

environment_user_id
string [ 1 .. 256 ] characters

The environment user ID to use to connect to the target environment.

repository_id
string [ 1 .. 256 ] characters

The ID of the target repository where to provision the VDB. A repository typically corresponds to a database installation (Oracle home, database instance, ...). Setting this attribute implicitly determines the environment where to provision the VDB.

auto_select_repository
boolean

Option to automatically select a compatible environment and repository. Mutually exclusive with repository_id.

vdb_restart
boolean

Indicates whether the Engine should automatically restart this virtual source when target host reboot is detected.

template_id
string [ 1 .. 256 ] characters

The ID of the target VDB Template (Oracle and MSSql Only).

auxiliary_template_id
string [ 1 .. 256 ] characters

The ID of the configuration template to apply to the auxiliary container database. This is only relevant when provisioning a Multitenant pluggable database into an existing CDB, i.e when the cdb_id property is set.(Oracle Only)

file_mapping_rules
string [ 1 .. 131072 ] characters

Target VDB file mapping rules (Oracle Only). Rules must be line separated (\n or \r) and each line must have the format "pattern:replacement". Lines are applied in order.

oracle_instance_name
string [ 1 .. 15 ] characters ^[a-zA-Z0-9_]+$

Target VDB SID name (Oracle Only).

unique_name
string [ 1 .. 30 ] characters ^[a-zA-Z0-9_\$#]+$

Target VDB db_unique_name (Oracle Only).

vcdb_name
string [ 1 .. 256 ] characters ^[a-zA-Z0-9_]+$

When provisioning an Oracle Multitenant vCDB (when the cdb_id property is not set), the name of the provisioned vCDB (Oracle Multitenant Only).

vcdb_database_name
string [ 1 .. 8 ] characters

When provisioning an Oracle Multitenant vCDB (when the cdb_id property is not set), the database name of the provisioned vCDB. Defaults to the value of the vcdb_name property. (Oracle Multitenant Only).

mount_point
string [ 1 .. 256 ] characters

Mount point for the VDB (Oracle, ASE, AppData).

open_reset_logs
boolean

Whether to open the database after provision (Oracle Only).

snapshot_policy_id
string [ 1 .. 256 ] characters

The ID of the snapshot policy for the VDB.

retention_policy_id
string [ 1 .. 256 ] characters

The ID of the retention policy for the VDB.

recovery_model
string

Recovery model of the source database (MSSql Only).

Enum: "FULL" "SIMPLE" "BULK_LOGGED"
pre_script
string [ 1 .. 1024 ] characters

PowerShell script or executable to run prior to provisioning (MSSql Only).

post_script
string [ 1 .. 1024 ] characters

PowerShell script or executable to run after provisioning (MSSql Only).

cdc_on_provision
boolean

Option to enable change data capture (CDC) on both the provisioned VDB and subsequent snapshot-related operations (e.g. refresh, rewind) (MSSql Only).

online_log_size
integer >= 4

Online log size in MB (Oracle Only).

online_log_groups
integer >= 2

Number of online log groups (Oracle Only).

archive_log
boolean

Option to create a VDB in archivelog mode (Oracle Only).

new_dbid
boolean

Option to generate a new DB ID for the created VDB (Oracle Only).

masked
boolean

Indicates whether to mark this VDB as a masked VDB.

listener_ids
Array of strings

The listener IDs for this provision operation (Oracle Only).

object

Environment variable to be set when the engine creates a VDB. See the Engine documentation for the list of allowed/denied environment variables and rules about substitution.

custom_env_files
Array of strings

Environment files to be sourced when the Engine creates a VDB. This path can be followed by parameters. Paths and parameters are separated by spaces.

Array of objects (OracleRacCustomEnvFile)

Environment files to be sourced when the Engine creates an Oracle RAC VDB. This path can be followed by parameters. Paths and parameters are separated by spaces.

Array of objects (OracleRacCustomEnvVar)

Environment variable to be set when the engine creates an Oracle RAC VDB. See the Engine documentation for the list of allowed/denied environment variables and rules about substitution.

parentTdeKeystorePath
string [ 1 .. 1024 ] characters

Path to a copy of the parent's Oracle transparent data encryption keystore on the target host. Required to provision from snapshots containing encrypted database files. (Oracle Multitenant Only)

parent_tde_keystore_password
string [ 1 .. 1024 ] characters

The password of the keystore specified in parentTdeKeystorePath. (Oracle Multitenant Only)

tde_exported_key_file_secret
string [ 1 .. 1024 ] characters

Secret to be used while exporting and importing vPDB encryption keys if Transparent Data Encryption is enabled on the vPDB. (Oracle Multitenant Only)

tde_key_identifier
string [ 1 .. 256 ] characters

ID of the key created by Delphix. (Oracle Multitenant Only)

target_vcdb_tde_keystore_path
string [ 1 .. 1024 ] characters

Path to the keystore of the target vCDB. (Oracle Multitenant Only)

cdb_tde_keystore_password
string [ 1 .. 1024 ] characters

The password for the Transparent Data Encryption keystore associated with the CDB. (Oracle Multitenant Only)

vcdb_tde_key_identifier
string [ 1 .. 256 ] characters

ID of the key created by Delphix. (Oracle Multitenant Only)

object

The JSON payload conforming to the DraftV4 schema based on the type of application data being manipulated.

Array of objects or null (AdditionalMountPoint)

Specifies additional locations on which to mount a subdirectory of an AppData container.

object or null

The list of parameters specified by the source config schema in the toolkit

object or null

Database configuration parameter overrides.

privileged_os_user
string <= 32 characters ^$|^[a-zA-Z_][a-zA-Z0-9_\-]+[$]?$

This privileged unix username will be used to create the VDB. Leave this field blank if you do not want to use privilege elevation. The unix privileged username should begin with a letter or an underscore, followed by letters, digits, underscores, or dashes. They can end with a dollar sign (postgres only).

postgres_port
integer [ 1 .. 65536 ]

Port number for Postgres target database (postgres only).

Array of objects (ConfigSettingsStg)

Custom Database-Level config settings (postgres only).

vcdb_restart
boolean

Indicates whether the Engine should automatically restart this vCDB when target host reboot is detected. If vdb_restart property value is not explicitly set and vcdb_restart is set as false - the vdb_restart property is defaulted to false.

mssql_failover_drive_letter
string = 1 characters

Base drive letter location for mount points. (MSSql Only).

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

The tags to be created for VDB.

invoke_datapatch
boolean

Whether to invoke datapatch during provisioning (Oracle Only).

location
string [ 1 .. 256 ] characters

The location to provision from.

timeflow_id
string [ 1 .. 256 ] characters

ID of the timeflow to provision from.

engine_id
string [ 1 .. 256 ] characters

The ID of the Engine onto which to provision. If the source ID unambiguously identifies a source object, this parameter is unnecessary and ignored.

source_data_id
string [ 1 .. 256 ] characters

The ID of the source object (dSource or VDB) to provision from. All other objects referenced by the parameters must live on the same engine as the source.

make_current_account_owner
boolean
Default: true

Whether the account provisioning this VDB must be configured as owner of the VDB.

Responses
200

VDB provisioning initiated.

post/vdbs/provision_by_location
Request samples
application/json
{
  • "pre_refresh": [
    ],
  • "post_refresh": [
    ],
  • "pre_self_refresh": [
    ],
  • "post_self_refresh": [
    ],
  • "pre_rollback": [
    ],
  • "post_rollback": [
    ],
  • "configure_clone": [
    ],
  • "pre_snapshot": [
    ],
  • "post_snapshot": [
    ],
  • "pre_start": [
    ],
  • "post_start": [
    ],
  • "pre_stop": [
    ],
  • "post_stop": [
    ],
  • "target_group_id": "group-123",
  • "name": "my-test-vdb",
  • "database_name": "my-test-database",
  • "cdb_id": "ORACLE_SINGLE_CONFIG-376",
  • "cluster_node_ids": [
    ],
  • "cluster_node_instances": [
    ],
  • "truncate_log_on_checkpoint": true,
  • "os_username": "os-user-x",
  • "os_password": "os-user-secret-password",
  • "environment_id": "environment-123",
  • "environment_user_id": "environment-user-123",
  • "repository_id": "oracle-home-123",
  • "auto_select_repository": true,
  • "vdb_restart": true,
  • "template_id": "template-123",
  • "auxiliary_template_id": "aux-template-123",
  • "file_mapping_rules": "/datafile/dbdhcp3/oradata/dbdhcp3:/data\n/u03/app/ora11202/product/11.2.0/dbhome_1/dbs/dbv_R2V4.dbf:/data/dbv_R2V4.dbf",
  • "oracle_instance_name": "dbdhcp2",
  • "unique_name": "dbdhcp2",
  • "vcdb_name": "VCCD_6QQ",
  • "vcdb_database_name": "VCCD_6QQ",
  • "mount_point": "/var/mnt",
  • "open_reset_logs": true,
  • "snapshot_policy_id": "snapshot-123",
  • "retention_policy_id": "retention-policy-123",
  • "recovery_model": "FULL",
  • "pre_script": "C:\\Program Files\\Delphix\\scripts\\myscript.ps1",
  • "post_script": "C:\\Program Files\\Delphix\\scripts\\myscript.ps1",
  • "cdc_on_provision": true,
  • "online_log_size": 4,
  • "online_log_groups": 2,
  • "archive_log": true,
  • "new_dbid": true,
  • "masked": true,
  • "listener_ids": [
    ],
  • "custom_env_vars": {
    },
  • "custom_env_files": [
    ],
  • "oracle_rac_custom_env_files": [
    ],
  • "oracle_rac_custom_env_vars": [
    ],
  • "parentTdeKeystorePath": "/foo/bar/tde",
  • "parent_tde_keystore_password": "password",
  • "tde_exported_key_file_secret": "secret",
  • "tde_key_identifier": "tde-indentifier",
  • "target_vcdb_tde_keystore_path": "/foo/cdb/tde",
  • "cdb_tde_keystore_password": "cdb-password",
  • "vcdb_tde_key_identifier": "vcdb-identifier",
  • "appdata_source_params": {
    },
  • "additional_mount_points": [
    ],
  • "appdata_config_params": {
    },
  • "config_params": {
    },
  • "privileged_os_user": "string",
  • "postgres_port": 1,
  • "config_settings_stg": [
    ],
  • "vcdb_restart": true,
  • "mssql_failover_drive_letter": "s",
  • "tags": [
    ],
  • "invoke_datapatch": false,
  • "location": "112233",
  • "timeflow_id": "timeflow_123",
  • "engine_id": "engine-123",
  • "source_data_id": "source-123",
  • "make_current_account_owner": true
}
Response samples
application/json
{
  • "job": {
    },
  • "vdb_id": "string"
}

Get default provision parameters for provisioning a new VDB by location.

SecurityApiKeyAuth
Request
Request Body schema: application/json
required

The request to get default VDB provision parameters for provisioning a new VDB by location.

source_data_id
string [ 1 .. 256 ] characters

The ID of the source object (dSource or VDB) to provision from. All other objects referenced by the parameters must live on the same engine as the source.

engine_id
string [ 1 .. 256 ] characters

The ID of the Engine onto which to provision. If the source ID unambiguously identifies a source object, this parameter is unnecessary and ignored.

location
string [ 1 .. 256 ] characters

The location to get the defaults from.

timeflow_id
string [ 1 .. 256 ] characters

ID of the timeflow to provision from.

Responses
200

Default VDB provisioning parameters.

post/vdbs/provision_by_location/defaults
Request samples
application/json
{
  • "source_data_id": "source-123",
  • "engine_id": "engine-123",
  • "location": "112233",
  • "timeflow_id": "timeflow_123"
}
Response samples
application/json
{
  • "pre_refresh": [
    ],
  • "post_refresh": [
    ],
  • "pre_self_refresh": [
    ],
  • "post_self_refresh": [
    ],
  • "pre_rollback": [
    ],
  • "post_rollback": [
    ],
  • "configure_clone": [
    ],
  • "pre_snapshot": [
    ],
  • "post_snapshot": [
    ],
  • "pre_start": [
    ],
  • "post_start": [
    ],
  • "pre_stop": [
    ],
  • "post_stop": [
    ],
  • "target_group_id": "group-123",
  • "name": "my-test-vdb",
  • "database_name": "my-test-database",
  • "cdb_id": "ORACLE_SINGLE_CONFIG-376",
  • "cluster_node_ids": [
    ],
  • "cluster_node_instances": [
    ],
  • "truncate_log_on_checkpoint": true,
  • "os_username": "os-user-x",
  • "os_password": "os-user-secret-password",
  • "environment_id": "environment-123",
  • "environment_user_id": "environment-user-123",
  • "repository_id": "oracle-home-123",
  • "auto_select_repository": true,
  • "vdb_restart": true,
  • "template_id": "template-123",
  • "auxiliary_template_id": "aux-template-123",
  • "file_mapping_rules": "/datafile/dbdhcp3/oradata/dbdhcp3:/data\n/u03/app/ora11202/product/11.2.0/dbhome_1/dbs/dbv_R2V4.dbf:/data/dbv_R2V4.dbf",
  • "oracle_instance_name": "dbdhcp2",
  • "unique_name": "dbdhcp2",
  • "vcdb_name": "VCCD_6QQ",
  • "vcdb_database_name": "VCCD_6QQ",
  • "mount_point": "/var/mnt",
  • "open_reset_logs": true,
  • "snapshot_policy_id": "snapshot-123",
  • "retention_policy_id": "retention-policy-123",
  • "recovery_model": "FULL",
  • "pre_script": "C:\\Program Files\\Delphix\\scripts\\myscript.ps1",
  • "post_script": "C:\\Program Files\\Delphix\\scripts\\myscript.ps1",
  • "cdc_on_provision": true,
  • "online_log_size": 4,
  • "online_log_groups": 2,
  • "archive_log": true,
  • "new_dbid": true,
  • "masked": true,
  • "listener_ids": [
    ],
  • "custom_env_vars": {
    },
  • "custom_env_files": [
    ],
  • "oracle_rac_custom_env_files": [
    ],
  • "oracle_rac_custom_env_vars": [
    ],
  • "parentTdeKeystorePath": "/foo/bar/tde",
  • "parent_tde_keystore_password": "password",
  • "tde_exported_key_file_secret": "secret",
  • "tde_key_identifier": "tde-indentifier",
  • "target_vcdb_tde_keystore_path": "/foo/cdb/tde",
  • "cdb_tde_keystore_password": "cdb-password",
  • "vcdb_tde_key_identifier": "vcdb-identifier",
  • "appdata_source_params": {
    },
  • "additional_mount_points": [
    ],
  • "appdata_config_params": {
    },
  • "config_params": {
    },
  • "privileged_os_user": "string",
  • "postgres_port": 1,
  • "config_settings_stg": [
    ],
  • "vcdb_restart": true,
  • "mssql_failover_drive_letter": "s",
  • "tags": [
    ],
  • "invoke_datapatch": false,
  • "location": "112233",
  • "timeflow_id": "timeflow_123",
  • "engine_id": "engine-123",
  • "source_data_id": "source-123",
  • "make_current_account_owner": true
}

Provision a new VDB by snapshot.

SecurityApiKeyAuth
Request
Request Body schema: application/json
required

The parameters to provision a VDB.

Array of objects (Hook) <= 100 items

The commands to execute on the target environment before refreshing the VDB.

Array of objects (Hook) <= 100 items

The commands to execute on the target environment after refreshing the VDB.

Array of objects (Hook) <= 100 items

The commands to execute on the target environment before refreshing the VDB with data from itself.

Array of objects (Hook) <= 100 items

The commands to execute on the target environment after refreshing the VDB with data from itself.

Array of objects (Hook) <= 100 items
Deprecated

The commands to execute on the target environment before rewinding the VDB.

Array of objects (Hook) <= 100 items
Deprecated

The commands to execute on the target environment after rewinding the VDB.

Array of objects (Hook) <= 100 items

The commands to execute on the target environment when the VDB is created or refreshed.

Array of objects (Hook) <= 100 items

The commands to execute on the target environment before snapshotting a virtual source. These commands can quiesce any data prior to snapshotting.

Array of objects (Hook) <= 100 items

The commands to execute on the target environment after snapshotting a virtual source.

Array of objects (Hook) <= 100 items

The commands to execute on the target environment before starting a virtual source.

Array of objects (Hook) <= 100 items

The commands to execute on the target environment after starting a virtual source.

Array of objects (Hook) <= 100 items

The commands to execute on the target environment before stopping a virtual source.

Array of objects (Hook) <= 100 items

The commands to execute on the target environment after stopping a virtual source.

target_group_id
string [ 1 .. 256 ] characters

The ID of the group into which the VDB will be provisioned. If unset, a group is selected randomly on the Engine.

name
string [ 1 .. 256 ] characters

The unique name of the provisioned VDB within a group. If unset, a name is randomly generated.

database_name
string [ 1 .. 256 ] characters

The name of the database on the target environment. Defaults to the value of the name property.

cdb_id
string [ 1 .. 256 ] characters

The ID of the container database (CDB) to provision an Oracle Multitenant database into. This corresponds to a CDB or VCDB API object. When this is not set, a new vCDB will be provisioned.

cluster_node_ids
Array of strings non-empty

The cluster node ids, name or addresses for this provision operation (Oracle RAC Only).

Array of objects (ClusterNodeInstance) non-empty

The cluster node instances details for this provision operation(Oracle RAC Only).This property is mutually exclusive with cluster_node_ids.

truncate_log_on_checkpoint
boolean

Whether to truncate log on checkpoint (ASE only).

os_username
string [ 1 .. 256 ] characters

The name of the privileged user to run the provision operation (Oracle Only).

os_password
string [ 1 .. 256 ] characters

The password of the privileged user to run the provision operation (Oracle Only).

environment_id
string [ 1 .. 256 ] characters

The ID of the target environment where to provision the VDB. If repository_id unambigously identifies a repository, this is unnecessary and ignored. Otherwise, a compatible repository is randomly selected on the environment.

environment_user_id
string [ 1 .. 256 ] characters

The environment user ID to use to connect to the target environment.

repository_id
string [ 1 .. 256 ] characters

The ID of the target repository where to provision the VDB. A repository typically corresponds to a database installation (Oracle home, database instance, ...). Setting this attribute implicitly determines the environment where to provision the VDB.

auto_select_repository
boolean

Option to automatically select a compatible environment and repository. Mutually exclusive with repository_id.

vdb_restart
boolean

Indicates whether the Engine should automatically restart this virtual source when target host reboot is detected.

template_id
string [ 1 .. 256 ] characters

The ID of the target VDB Template (Oracle and MSSql Only).

auxiliary_template_id
string [ 1 .. 256 ] characters

The ID of the configuration template to apply to the auxiliary container database. This is only relevant when provisioning a Multitenant pluggable database into an existing CDB, i.e when the cdb_id property is set.(Oracle Only)

file_mapping_rules
string [ 1 .. 131072 ] characters

Target VDB file mapping rules (Oracle Only). Rules must be line separated (\n or \r) and each line must have the format "pattern:replacement". Lines are applied in order.

oracle_instance_name
string [ 1 .. 15 ] characters ^[a-zA-Z0-9_]+$

Target VDB SID name (Oracle Only).

unique_name
string [ 1 .. 30 ] characters ^[a-zA-Z0-9_\$#]+$

Target VDB db_unique_name (Oracle Only).

vcdb_name
string [ 1 .. 256 ] characters ^[a-zA-Z0-9_]+$

When provisioning an Oracle Multitenant vCDB (when the cdb_id property is not set), the name of the provisioned vCDB (Oracle Multitenant Only).

vcdb_database_name
string [ 1 .. 8 ] characters

When provisioning an Oracle Multitenant vCDB (when the cdb_id property is not set), the database name of the provisioned vCDB. Defaults to the value of the vcdb_name property. (Oracle Multitenant Only).

mount_point
string [ 1 .. 256 ] characters

Mount point for the VDB (Oracle, ASE, AppData).

open_reset_logs
boolean

Whether to open the database after provision (Oracle Only).

snapshot_policy_id
string [ 1 .. 256 ] characters

The ID of the snapshot policy for the VDB.

retention_policy_id
string [ 1 .. 256 ] characters

The ID of the retention policy for the VDB.

recovery_model
string

Recovery model of the source database (MSSql Only).

Enum: "FULL" "SIMPLE" "BULK_LOGGED"
pre_script
string [ 1 .. 1024 ] characters

PowerShell script or executable to run prior to provisioning (MSSql Only).

post_script
string [ 1 .. 1024 ] characters

PowerShell script or executable to run after provisioning (MSSql Only).

cdc_on_provision
boolean

Option to enable change data capture (CDC) on both the provisioned VDB and subsequent snapshot-related operations (e.g. refresh, rewind) (MSSql Only).

online_log_size
integer >= 4

Online log size in MB (Oracle Only).

online_log_groups
integer >= 2

Number of online log groups (Oracle Only).

archive_log
boolean

Option to create a VDB in archivelog mode (Oracle Only).

new_dbid
boolean

Option to generate a new DB ID for the created VDB (Oracle Only).

masked
boolean

Indicates whether to mark this VDB as a masked VDB.

listener_ids
Array of strings

The listener IDs for this provision operation (Oracle Only).

object

Environment variable to be set when the engine creates a VDB. See the Engine documentation for the list of allowed/denied environment variables and rules about substitution.

custom_env_files
Array of strings

Environment files to be sourced when the Engine creates a VDB. This path can be followed by parameters. Paths and parameters are separated by spaces.

Array of objects (OracleRacCustomEnvFile)

Environment files to be sourced when the Engine creates an Oracle RAC VDB. This path can be followed by parameters. Paths and parameters are separated by spaces.

Array of objects (OracleRacCustomEnvVar)

Environment variable to be set when the engine creates an Oracle RAC VDB. See the Engine documentation for the list of allowed/denied environment variables and rules about substitution.

parentTdeKeystorePath
string [ 1 .. 1024 ] characters

Path to a copy of the parent's Oracle transparent data encryption keystore on the target host. Required to provision from snapshots containing encrypted database files. (Oracle Multitenant Only)

parent_tde_keystore_password
string [ 1 .. 1024 ] characters

The password of the keystore specified in parentTdeKeystorePath. (Oracle Multitenant Only)

tde_exported_key_file_secret
string [ 1 .. 1024 ] characters

Secret to be used while exporting and importing vPDB encryption keys if Transparent Data Encryption is enabled on the vPDB. (Oracle Multitenant Only)

tde_key_identifier
string [ 1 .. 256 ] characters

ID of the key created by Delphix. (Oracle Multitenant Only)

target_vcdb_tde_keystore_path
string [ 1 .. 1024 ] characters

Path to the keystore of the target vCDB. (Oracle Multitenant Only)

cdb_tde_keystore_password
string [ 1 .. 1024 ] characters

The password for the Transparent Data Encryption keystore associated with the CDB. (Oracle Multitenant Only)

vcdb_tde_key_identifier
string [ 1 .. 256 ] characters

ID of the key created by Delphix. (Oracle Multitenant Only)

object

The JSON payload conforming to the DraftV4 schema based on the type of application data being manipulated.

Array of objects or null (AdditionalMountPoint)

Specifies additional locations on which to mount a subdirectory of an AppData container.

object or null

The list of parameters specified by the source config schema in the toolkit

object or null

Database configuration parameter overrides.

privileged_os_user
string <= 32 characters ^$|^[a-zA-Z_][a-zA-Z0-9_\-]+[$]?$

This privileged unix username will be used to create the VDB. Leave this field blank if you do not want to use privilege elevation. The unix privileged username should begin with a letter or an underscore, followed by letters, digits, underscores, or dashes. They can end with a dollar sign (postgres only).

postgres_port
integer [ 1 .. 65536 ]

Port number for Postgres target database (postgres only).

Array of objects (ConfigSettingsStg)

Custom Database-Level config settings (postgres only).

vcdb_restart
boolean

Indicates whether the Engine should automatically restart this vCDB when target host reboot is detected. If vdb_restart property value is not explicitly set and vcdb_restart is set as false - the vdb_restart property is defaulted to false.

mssql_failover_drive_letter
string = 1 characters

Base drive letter location for mount points. (MSSql Only).

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

The tags to be created for VDB.

invoke_datapatch
boolean

Whether to invoke datapatch during provisioning (Oracle Only).

snapshot_id
string [ 1 .. 256 ] characters

The ID of the snapshot from which to execute the operation. If the snapshot_id is not, selects the latest snapshot.

engine_id
string [ 1 .. 256 ] characters

The ID of the Engine onto which to provision. If the source ID unambiguously identifies a source object, this parameter is unnecessary and ignored.

source_data_id
string [ 1 .. 256 ] characters

The ID of the source object (dSource or VDB) to provision from. All other objects referenced by the parameters must live on the same engine as the source. If this property is not set, the data_source of the snapshot_id will be used.

make_current_account_owner
boolean
Default: true

Whether the account provisioning this VDB must be configured as owner of the VDB.

Responses
200

VDB provisioning initiated.

post/vdbs/provision_by_snapshot
Request samples
application/json

The above request example is intended for Oracle Database without including optional properties

{
  • "auto_select_repository": true,
  • "source_data_id": "dsource-name",
  • "tags": [
    ]
}
Response samples
application/json
{
  • "job": {
    },
  • "vdb_id": "string"
}

Get default provision parameters for provisioning a new VDB by snapshot.

SecurityApiKeyAuth
Request
Request Body schema: application/json
required

The request to get default VDB provision parameters for provisioning a new VDB by snapshot.

snapshot_id
string [ 1 .. 256 ] characters

The ID of the snapshot from which to execute the operation.

engine_id
string [ 1 .. 256 ] characters

The ID of the Engine onto which to provision. If the source ID unambiguously identifies a source object, this parameter is unnecessary and ignored.

source_data_id
string [ 1 .. 256 ] characters

The ID of the source object (dSource or VDB) to provision from. If this property is not set, the data_source of the snapshot_id will be used.

Responses
200

Default VDB provisioning parameters.

post/vdbs/provision_by_snapshot/defaults
Request samples
application/json
{
  • "snapshot_id": "snapshot-123",
  • "engine_id": "engine-123",
  • "source_data_id": "source-123"
}
Response samples
application/json
{
  • "pre_refresh": [
    ],
  • "post_refresh": [
    ],
  • "pre_self_refresh": [
    ],
  • "post_self_refresh": [
    ],
  • "pre_rollback": [
    ],
  • "post_rollback": [
    ],
  • "configure_clone": [
    ],
  • "pre_snapshot": [
    ],
  • "post_snapshot": [
    ],
  • "pre_start": [
    ],
  • "post_start": [
    ],
  • "pre_stop": [
    ],
  • "post_stop": [
    ],
  • "target_group_id": "group-123",
  • "name": "my-test-vdb",
  • "database_name": "my-test-database",
  • "cdb_id": "ORACLE_SINGLE_CONFIG-376",
  • "cluster_node_ids": [
    ],
  • "cluster_node_instances": [
    ],
  • "truncate_log_on_checkpoint": true,
  • "os_username": "os-user-x",
  • "os_password": "os-user-secret-password",
  • "environment_id": "environment-123",
  • "environment_user_id": "environment-user-123",
  • "repository_id": "oracle-home-123",
  • "auto_select_repository": true,
  • "vdb_restart": true,
  • "template_id": "template-123",
  • "auxiliary_template_id": "aux-template-123",
  • "file_mapping_rules": "/datafile/dbdhcp3/oradata/dbdhcp3:/data\n/u03/app/ora11202/product/11.2.0/dbhome_1/dbs/dbv_R2V4.dbf:/data/dbv_R2V4.dbf",
  • "oracle_instance_name": "dbdhcp2",
  • "unique_name": "dbdhcp2",
  • "vcdb_name": "VCCD_6QQ",
  • "vcdb_database_name": "VCCD_6QQ",
  • "mount_point": "/var/mnt",
  • "open_reset_logs": true,
  • "snapshot_policy_id": "snapshot-123",
  • "retention_policy_id": "retention-policy-123",
  • "recovery_model": "FULL",
  • "pre_script": "C:\\Program Files\\Delphix\\scripts\\myscript.ps1",
  • "post_script": "C:\\Program Files\\Delphix\\scripts\\myscript.ps1",
  • "cdc_on_provision": true,
  • "online_log_size": 4,
  • "online_log_groups": 2,
  • "archive_log": true,
  • "new_dbid": true,
  • "masked": true,
  • "listener_ids": [
    ],
  • "custom_env_vars": {
    },
  • "custom_env_files": [
    ],
  • "oracle_rac_custom_env_files": [
    ],
  • "oracle_rac_custom_env_vars": [
    ],
  • "parentTdeKeystorePath": "/foo/bar/tde",
  • "parent_tde_keystore_password": "password",
  • "tde_exported_key_file_secret": "secret",
  • "tde_key_identifier": "tde-indentifier",
  • "target_vcdb_tde_keystore_path": "/foo/cdb/tde",
  • "cdb_tde_keystore_password": "cdb-password",
  • "vcdb_tde_key_identifier": "vcdb-identifier",
  • "appdata_source_params": {
    },
  • "additional_mount_points": [
    ],
  • "appdata_config_params": {
    },
  • "config_params": {
    },
  • "privileged_os_user": "string",
  • "postgres_port": 1,
  • "config_settings_stg": [
    ],
  • "vcdb_restart": true,
  • "mssql_failover_drive_letter": "s",
  • "tags": [
    ],
  • "invoke_datapatch": false,
  • "snapshot_id": "string",
  • "engine_id": "engine-123",
  • "source_data_id": "source-123",
  • "make_current_account_owner": true
}

Provision a new VDB from a bookmark with a single VDB.

SecurityApiKeyAuth
Request
Request Body schema: application/json
required

The parameters to provision a VDB.

Array of objects (Hook) <= 100 items

The commands to execute on the target environment before refreshing the VDB.

Array of objects (Hook) <= 100 items

The commands to execute on the target environment after refreshing the VDB.

Array of objects (Hook) <= 100 items

The commands to execute on the target environment before refreshing the VDB with data from itself.

Array of objects (Hook) <= 100 items

The commands to execute on the target environment after refreshing the VDB with data from itself.

Array of objects (Hook) <= 100 items
Deprecated

The commands to execute on the target environment before rewinding the VDB.

Array of objects (Hook) <= 100 items
Deprecated

The commands to execute on the target environment after rewinding the VDB.

Array of objects (Hook) <= 100 items

The commands to execute on the target environment when the VDB is created or refreshed.

Array of objects (Hook) <= 100 items

The commands to execute on the target environment before snapshotting a virtual source. These commands can quiesce any data prior to snapshotting.

Array of objects (Hook) <= 100 items

The commands to execute on the target environment after snapshotting a virtual source.

Array of objects (Hook) <= 100 items

The commands to execute on the target environment before starting a virtual source.

Array of objects (Hook) <= 100 items

The commands to execute on the target environment after starting a virtual source.

Array of objects (Hook) <= 100 items

The commands to execute on the target environment before stopping a virtual source.

Array of objects (Hook) <= 100 items

The commands to execute on the target environment after stopping a virtual source.

target_group_id
string [ 1 .. 256 ] characters

The ID of the group into which the VDB will be provisioned. If unset, a group is selected randomly on the Engine.

name
string [ 1 .. 256 ] characters

The unique name of the provisioned VDB within a group. If unset, a name is randomly generated.

database_name
string [ 1 .. 256 ] characters

The name of the database on the target environment. Defaults to the value of the name property.

cdb_id
string [ 1 .. 256 ] characters

The ID of the container database (CDB) to provision an Oracle Multitenant database into. This corresponds to a CDB or VCDB API object. When this is not set, a new vCDB will be provisioned.

cluster_node_ids
Array of strings non-empty

The cluster node ids, name or addresses for this provision operation (Oracle RAC Only).

Array of objects (ClusterNodeInstance) non-empty

The cluster node instances details for this provision operation(Oracle RAC Only).This property is mutually exclusive with cluster_node_ids.

truncate_log_on_checkpoint
boolean

Whether to truncate log on checkpoint (ASE only).

os_username
string [ 1 .. 256 ] characters

The name of the privileged user to run the provision operation (Oracle Only).

os_password
string [ 1 .. 256 ] characters

The password of the privileged user to run the provision operation (Oracle Only).

environment_id
string [ 1 .. 256 ] characters

The ID of the target environment where to provision the VDB. If repository_id unambigously identifies a repository, this is unnecessary and ignored. Otherwise, a compatible repository is randomly selected on the environment.

environment_user_id
string [ 1 .. 256 ] characters

The environment user ID to use to connect to the target environment.

repository_id
string [ 1 .. 256 ] characters

The ID of the target repository where to provision the VDB. A repository typically corresponds to a database installation (Oracle home, database instance, ...). Setting this attribute implicitly determines the environment where to provision the VDB.

auto_select_repository
boolean

Option to automatically select a compatible environment and repository. Mutually exclusive with repository_id.

vdb_restart
boolean

Indicates whether the Engine should automatically restart this virtual source when target host reboot is detected.

template_id
string [ 1 .. 256 ] characters

The ID of the target VDB Template (Oracle and MSSql Only).

auxiliary_template_id
string [ 1 .. 256 ] characters

The ID of the configuration template to apply to the auxiliary container database. This is only relevant when provisioning a Multitenant pluggable database into an existing CDB, i.e when the cdb_id property is set.(Oracle Only)

file_mapping_rules
string [ 1 .. 131072 ] characters

Target VDB file mapping rules (Oracle Only). Rules must be line separated (\n or \r) and each line must have the format "pattern:replacement". Lines are applied in order.

oracle_instance_name
string [ 1 .. 15 ] characters ^[a-zA-Z0-9_]+$

Target VDB SID name (Oracle Only).

unique_name
string [ 1 .. 30 ] characters ^[a-zA-Z0-9_\$#]+$

Target VDB db_unique_name (Oracle Only).

vcdb_name
string [ 1 .. 256 ] characters ^[a-zA-Z0-9_]+$

When provisioning an Oracle Multitenant vCDB (when the cdb_id property is not set), the name of the provisioned vCDB (Oracle Multitenant Only).

vcdb_database_name
string [ 1 .. 8 ] characters

When provisioning an Oracle Multitenant vCDB (when the cdb_id property is not set), the database name of the provisioned vCDB. Defaults to the value of the vcdb_name property. (Oracle Multitenant Only).

mount_point
string [ 1 .. 256 ] characters

Mount point for the VDB (Oracle, ASE, AppData).

open_reset_logs
boolean

Whether to open the database after provision (Oracle Only).

snapshot_policy_id
string [ 1 .. 256 ] characters

The ID of the snapshot policy for the VDB.

retention_policy_id
string [ 1 .. 256 ] characters

The ID of the retention policy for the VDB.

recovery_model
string

Recovery model of the source database (MSSql Only).

Enum: "FULL" "SIMPLE" "BULK_LOGGED"
pre_script
string [ 1 .. 1024 ] characters

PowerShell script or executable to run prior to provisioning (MSSql Only).

post_script
string [ 1 .. 1024 ] characters

PowerShell script or executable to run after provisioning (MSSql Only).

cdc_on_provision
boolean

Option to enable change data capture (CDC) on both the provisioned VDB and subsequent snapshot-related operations (e.g. refresh, rewind) (MSSql Only).

online_log_size
integer >= 4

Online log size in MB (Oracle Only).

online_log_groups
integer >= 2

Number of online log groups (Oracle Only).

archive_log
boolean

Option to create a VDB in archivelog mode (Oracle Only).

new_dbid
boolean

Option to generate a new DB ID for the created VDB (Oracle Only).

masked
boolean

Indicates whether to mark this VDB as a masked VDB.

listener_ids
Array of strings

The listener IDs for this provision operation (Oracle Only).

object

Environment variable to be set when the engine creates a VDB. See the Engine documentation for the list of allowed/denied environment variables and rules about substitution.

custom_env_files
Array of strings

Environment files to be sourced when the Engine creates a VDB. This path can be followed by parameters. Paths and parameters are separated by spaces.

Array of objects (OracleRacCustomEnvFile)

Environment files to be sourced when the Engine creates an Oracle RAC VDB. This path can be followed by parameters. Paths and parameters are separated by spaces.

Array of objects (OracleRacCustomEnvVar)

Environment variable to be set when the engine creates an Oracle RAC VDB. See the Engine documentation for the list of allowed/denied environment variables and rules about substitution.

parentTdeKeystorePath
string [ 1 .. 1024 ] characters

Path to a copy of the parent's Oracle transparent data encryption keystore on the target host. Required to provision from snapshots containing encrypted database files. (Oracle Multitenant Only)

parent_tde_keystore_password
string [ 1 .. 1024 ] characters

The password of the keystore specified in parentTdeKeystorePath. (Oracle Multitenant Only)

tde_exported_key_file_secret
string [ 1 .. 1024 ] characters

Secret to be used while exporting and importing vPDB encryption keys if Transparent Data Encryption is enabled on the vPDB. (Oracle Multitenant Only)

tde_key_identifier
string [ 1 .. 256 ] characters

ID of the key created by Delphix. (Oracle Multitenant Only)

target_vcdb_tde_keystore_path
string [ 1 .. 1024 ] characters

Path to the keystore of the target vCDB. (Oracle Multitenant Only)

cdb_tde_keystore_password
string [ 1 .. 1024 ] characters

The password for the Transparent Data Encryption keystore associated with the CDB. (Oracle Multitenant Only)

vcdb_tde_key_identifier
string [ 1 .. 256 ] characters

ID of the key created by Delphix. (Oracle Multitenant Only)

object

The JSON payload conforming to the DraftV4 schema based on the type of application data being manipulated.

Array of objects or null (AdditionalMountPoint)

Specifies additional locations on which to mount a subdirectory of an AppData container.

object or null

The list of parameters specified by the source config schema in the toolkit

object or null

Database configuration parameter overrides.

privileged_os_user
string <= 32 characters ^$|^[a-zA-Z_][a-zA-Z0-9_\-]+[$]?$

This privileged unix username will be used to create the VDB. Leave this field blank if you do not want to use privilege elevation. The unix privileged username should begin with a letter or an underscore, followed by letters, digits, underscores, or dashes. They can end with a dollar sign (postgres only).

postgres_port
integer [ 1 .. 65536 ]

Port number for Postgres target database (postgres only).

Array of objects (ConfigSettingsStg)

Custom Database-Level config settings (postgres only).

vcdb_restart
boolean

Indicates whether the Engine should automatically restart this vCDB when target host reboot is detected. If vdb_restart property value is not explicitly set and vcdb_restart is set as false - the vdb_restart property is defaulted to false.

mssql_failover_drive_letter
string = 1 characters

Base drive letter location for mount points. (MSSql Only).

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

The tags to be created for VDB.

invoke_datapatch
boolean

Whether to invoke datapatch during provisioning (Oracle Only).

bookmark_id
required
string [ 1 .. 256 ] characters

The ID of the bookmark from which to execute the operation. The bookmark must contain only one VDB.

make_current_account_owner
boolean
Default: true

Whether the account provisioning this VDB must be configured as owner of the VDB.

Responses
200

VDB provisioning initiated.

post/vdbs/provision_from_bookmark
Request samples
application/json
{
  • "pre_refresh": [
    ],
  • "post_refresh": [
    ],
  • "pre_self_refresh": [
    ],
  • "post_self_refresh": [
    ],
  • "pre_rollback": [
    ],
  • "post_rollback": [
    ],
  • "configure_clone": [
    ],
  • "pre_snapshot": [
    ],
  • "post_snapshot": [
    ],
  • "pre_start": [
    ],
  • "post_start": [
    ],
  • "pre_stop": [
    ],
  • "post_stop": [
    ],
  • "target_group_id": "group-123",
  • "name": "my-test-vdb",
  • "database_name": "my-test-database",
  • "cdb_id": "ORACLE_SINGLE_CONFIG-376",
  • "cluster_node_ids": [
    ],
  • "cluster_node_instances": [
    ],
  • "truncate_log_on_checkpoint": true,
  • "os_username": "os-user-x",
  • "os_password": "os-user-secret-password",
  • "environment_id": "environment-123",
  • "environment_user_id": "environment-user-123",
  • "repository_id": "oracle-home-123",
  • "auto_select_repository": true,
  • "vdb_restart": true,
  • "template_id": "template-123",
  • "auxiliary_template_id": "aux-template-123",
  • "file_mapping_rules": "/datafile/dbdhcp3/oradata/dbdhcp3:/data\n/u03/app/ora11202/product/11.2.0/dbhome_1/dbs/dbv_R2V4.dbf:/data/dbv_R2V4.dbf",
  • "oracle_instance_name": "dbdhcp2",
  • "unique_name": "dbdhcp2",
  • "vcdb_name": "VCCD_6QQ",
  • "vcdb_database_name": "VCCD_6QQ",
  • "mount_point": "/var/mnt",
  • "open_reset_logs": true,
  • "snapshot_policy_id": "snapshot-123",
  • "retention_policy_id": "retention-policy-123",
  • "recovery_model": "FULL",
  • "pre_script": "C:\\Program Files\\Delphix\\scripts\\myscript.ps1",
  • "post_script": "C:\\Program Files\\Delphix\\scripts\\myscript.ps1",
  • "cdc_on_provision": true,
  • "online_log_size": 4,
  • "online_log_groups": 2,
  • "archive_log": true,
  • "new_dbid": true,
  • "masked": true,
  • "listener_ids": [
    ],
  • "custom_env_vars": {
    },
  • "custom_env_files": [
    ],
  • "oracle_rac_custom_env_files": [
    ],
  • "oracle_rac_custom_env_vars": [
    ],
  • "parentTdeKeystorePath": "/foo/bar/tde",
  • "parent_tde_keystore_password": "password",
  • "tde_exported_key_file_secret": "secret",
  • "tde_key_identifier": "tde-indentifier",
  • "target_vcdb_tde_keystore_path": "/foo/cdb/tde",
  • "cdb_tde_keystore_password": "cdb-password",
  • "vcdb_tde_key_identifier": "vcdb-identifier",
  • "appdata_source_params": {
    },
  • "additional_mount_points": [
    ],
  • "appdata_config_params": {
    },
  • "config_params": {
    },
  • "privileged_os_user": "string",
  • "postgres_port": 1,
  • "config_settings_stg": [
    ],
  • "vcdb_restart": true,
  • "mssql_failover_drive_letter": "s",
  • "tags": [
    ],
  • "invoke_datapatch": false,
  • "bookmark_id": "string",
  • "make_current_account_owner": true
}
Response samples
application/json
{
  • "job": {
    },
  • "vdb_id": "string"
}

Get default provision parameters for provisioning a new VDB from a bookmark.

SecurityApiKeyAuth
Request
Request Body schema: application/json
required

The request to get default VDB provision parameters for provisioning a new VDB from a bookmark.

bookmark_id
required
string [ 1 .. 256 ] characters

The ID of the bookmark from which to execute the operation. The bookmark must contain only one VDB.

Responses
200

Default VDB provisioning parameters.

post/vdbs/provision_from_bookmark/defaults
Request samples
application/json
{
  • "bookmark_id": "string"
}
Response samples
application/json
{
  • "pre_refresh": [
    ],
  • "post_refresh": [
    ],
  • "pre_self_refresh": [
    ],
  • "post_self_refresh": [
    ],
  • "pre_rollback": [
    ],
  • "post_rollback": [
    ],
  • "configure_clone": [
    ],
  • "pre_snapshot": [
    ],
  • "post_snapshot": [
    ],
  • "pre_start": [
    ],
  • "post_start": [
    ],
  • "pre_stop": [
    ],
  • "post_stop": [
    ],
  • "target_group_id": "group-123",
  • "name": "my-test-vdb",
  • "database_name": "my-test-database",
  • "cdb_id": "ORACLE_SINGLE_CONFIG-376",
  • "cluster_node_ids": [
    ],
  • "cluster_node_instances": [
    ],
  • "truncate_log_on_checkpoint": true,
  • "os_username": "os-user-x",
  • "os_password": "os-user-secret-password",
  • "environment_id": "environment-123",
  • "environment_user_id": "environment-user-123",
  • "repository_id": "oracle-home-123",
  • "auto_select_repository": true,
  • "vdb_restart": true,
  • "template_id": "template-123",
  • "auxiliary_template_id": "aux-template-123",
  • "file_mapping_rules": "/datafile/dbdhcp3/oradata/dbdhcp3:/data\n/u03/app/ora11202/product/11.2.0/dbhome_1/dbs/dbv_R2V4.dbf:/data/dbv_R2V4.dbf",
  • "oracle_instance_name": "dbdhcp2",
  • "unique_name": "dbdhcp2",
  • "vcdb_name": "VCCD_6QQ",
  • "vcdb_database_name": "VCCD_6QQ",
  • "mount_point": "/var/mnt",
  • "open_reset_logs": true,
  • "snapshot_policy_id": "snapshot-123",
  • "retention_policy_id": "retention-policy-123",
  • "recovery_model": "FULL",
  • "pre_script": "C:\\Program Files\\Delphix\\scripts\\myscript.ps1",
  • "post_script": "C:\\Program Files\\Delphix\\scripts\\myscript.ps1",
  • "cdc_on_provision": true,
  • "online_log_size": 4,
  • "online_log_groups": 2,
  • "archive_log": true,
  • "new_dbid": true,
  • "masked": true,
  • "listener_ids": [
    ],
  • "custom_env_vars": {
    },
  • "custom_env_files": [
    ],
  • "oracle_rac_custom_env_files": [
    ],
  • "oracle_rac_custom_env_vars": [
    ],
  • "parentTdeKeystorePath": "/foo/bar/tde",
  • "parent_tde_keystore_password": "password",
  • "tde_exported_key_file_secret": "secret",
  • "tde_key_identifier": "tde-indentifier",
  • "target_vcdb_tde_keystore_path": "/foo/cdb/tde",
  • "cdb_tde_keystore_password": "cdb-password",
  • "vcdb_tde_key_identifier": "vcdb-identifier",
  • "appdata_source_params": {
    },
  • "additional_mount_points": [
    ],
  • "appdata_config_params": {
    },
  • "config_params": {
    },
  • "privileged_os_user": "string",
  • "postgres_port": 1,
  • "config_settings_stg": [
    ],
  • "vcdb_restart": true,
  • "mssql_failover_drive_letter": "s",
  • "tags": [
    ],
  • "invoke_datapatch": false,
  • "bookmark_id": "string",
  • "make_current_account_owner": true
}
➔ Next to VDBGroups