Skip to content
/
Create a repository.

Create a repository.

Request

Security
ApiKeyAuth
Path
environmentIdstring, non-emptyrequired

The ID of the environment.

Bodyapplication/jsonrequired
database_typestringrequired

The database type of this repository.

Enum:"ORACLE""MSSQL"
bitsinteger

32 or 64 bits.

Enum:3264
installation_homestring, [ 1 .. 300 ] characters

The Oracle install or SQL Server instance home.

versionstring

Version of the oracle repository or SQL Server instance.

oracle_basestring, <= 256 characters

The Oracle base where database binaries are located.

allow_provisioningboolean

Flag indicating whether the repository should be used for provisioning.

Default:true
is_stagingboolean

Flag indicating whether this repository can be used by the Delphix Engine for internal processing.

Default:false
applied_patchesArray of integers, (int64)

List of Oracle patches that have been applied to this Oracle Home.

full_text_installedboolean

This property determines if the full-text search and semantic search is installed or not (MSSql only).

server_namestring, <= 128 characters

The Server Name of the SQL Server instance.

portinteger, (int64)

The network port for connecting to the SQL Server instance.

instance_ownerstring, [ 1 .. 255 ] characters

Account the SQL Server instance is running as.

instance_namestring, [ 1 .. 256 ] characters

The name of the SQL Server instance.

The request example is intended for creating a oracle repository.

curl -i -X POST \
  'https://help-api.delphix.com/_mock/data-control-tower/continuous-data/22.0.0/continuous-data-apis-dct-22.0.0/environments/{environmentId}/repository' \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "database_type": "ORACLE",
    "bits": 32,
    "installation_home": "/u01/app/oracle/product/18.0.0.0/dbhome_1",
    "version": "18.3.0.0.0"
  }'

Responses

Repository creation initiated

Bodyapplication/json
jobobject(Job)

An asynchronous task.

repository_idstring

The id of the created repository.

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