Release Information


Getting Started

Delphix Engine System Administration

Virtual Database Management with the Delphix Engine

Data Backup and Recovery

Delphix Modernization Engine

Delphix Masking

Virtualizing Unstructured Files in the Delphix Engine

Virtualizing Oracle E-Business Suite in the Delphix Engine


Mission Control

Delphix Express User Guide


Documentation for Previous Versions of the Delphix Engine

Delphix Server 3.0 Documentation
Delphix Server 3.1 Documentation
Delphix Engine 3.2 Documentation
Delphix Engine 4.0 Documentation
Delphix Engine 4.1 Documentation
Delphix Engine 4.2 Documentation
Delphix Engine 4.3 Documentation

Skip to end of metadata
Go to start of metadata

This API cookbook recipe demonstrates how to provision an Oracle VDB using the Delphix Engine API.

In order to provision an Oracle VDB using the API, you need to provide a set of parameters of type OracleProvisionParameters (having already authenticated as per API Cookbook: Authentication).

There are a number of parameters you will need to know:

  • Group reference  -  See the list operation in "/api/#group" on your Delphix Engine.

  • VDB name  -  The name you want the new VDB to be called.
  • Mount path  -  Where to mount datasets on the target host.
  • DB/unique names  -  The Oracle DB and unique names, often the same as the VDB name.
  • Instance name/number  -  The Oracle instance name and number to use (dictated by your environment, but often VDB name and 1).
  • Repository reference  -  See the list operation in "/api/#repository" on your Delphix Engine.
  • Timeflow point  -  See API Cookbook: List Snapshots for information on finding a timeflow point, as well as the reference at "/api/#TimeflowPointParameters".

You will need to use the structure of the OracleProvisionParameters object to fill it out, see "/api/#OracleProvisionParameters" for details on which fields are mandatory/optional.


Here is a minimal example using curl to communicate with the API, provisioning a VDB called "EGVDB" (authentication omitted)
curl -X POST -k --data @- \
	-b cookies.txt -H "Content-Type: application/json" <<EOF
	"container": {
		"group": "GROUP-2",
		"name": "EGVDB", 
		"type": "OracleDatabaseContainer"
	"source": {
		"type": "OracleVirtualSource",
		"mountBase": "/mnt/provision" 
	"sourceConfig": {
		"type": "OracleSIConfig",
		"databaseName": "EGVDB", 
		"uniqueName": "EGVDB", 
		"repository": "ORACLE_INSTALL-3",
		"instance": {
			"type": "OracleInstance",
			"instanceName": "EGVDB",
			"instanceNumber": 1
	"timeflowPointParameters": {
		"type": "TimeflowPointLocation",
		"timeflow": "ORACLE_TIMEFLOW-123",
		"location": "3043123"
	"type": "OracleProvisionParameters"




  • No labels