Link an AppData database as dSource.

Request

Security

ApiKeyAuth

Bodyapplication/jsonrequired

The parameters to link an AppData dSource.

namestring, [ 1 .. 256 ] characters

Name of the dSource to be created.

source_idstring, [ 1 .. 256 ] characters

Id of the source to link.

group_idstring, [ 1 .. 256 ] characters

Id of the dataset group where this dSource should belong to.

descriptionstring, [ 1 .. 1024 ] characters

The notes/description for the dSource.

log_sync_enabledboolean

True if LogSync should run for this database.

Default:false

sync_policy_idstring, [ 1 .. 256 ] characters

The ID of the SnapSync policy for the dSource.

Example:"snapshot-123"

retention_policy_idstring, [ 1 .. 256 ] characters

The ID of the Retention policy for the dSource.

Example:"retention-policy-123"

make_current_account_ownerboolean

Whether the account creating this reporting schedule must be configured as owner of the reporting schedule.

Default:true

tagsArray of objects, [ 1 .. 1000 ] items(Tag)

The tags to be created for dSource.

ops_pre_syncArray of objects(SourceOperation)

Operations to perform before syncing the created dSource. These operations can quiesce any data prior to syncing.

ops_post_syncArray of objects(SourceOperation)

Operations to perform after syncing a created dSource.

link_typestring

The type of link to create. Default is AppDataDirect.

AppDataDirect - Represents the AppData specific parameters of a link request for a source directly replicated into the Delphix Engine.
AppDataStaged - Represents the AppData specific parameters of a link request for a source with a staging source.

Default:"AppDataDirect"

Enum:"AppDataDirect""AppDataStaged"

staging_mount_basestring, <= 256 characters

The base mount point for the NFS mount on the staging environment [AppDataStaged only].

staging_environmentstring

The environment used as an intermediate stage to pull data into Delphix [AppDataStaged only].

staging_environment_userstring

The environment user used to access the staging environment [AppDataStaged only].

environment_userstring, [ 1 .. 256 ] charactersrequired

The OS user to use for linking.

excludesArray of strings

List of subdirectories in the source to exclude when syncing data. These paths are relative to the root of the source directory. [AppDataDirect only]

follow_symlinksArray of strings

List of symlinks in the source to follow when syncing data. These paths are relative to the root of the source directory. All other symlinks are preserved. [AppDataDirect only]

parametersobjectrequired

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

sync_parametersobjectrequired

The JSON payload conforming to the snapshot parameters definition in a LUA toolkit or platform plugin.

The above request example is intended for a Postgres AppData linking

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/dsources/appdata \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "source_id": "1-APPDATA_STAGED_SOURCE_CONFIG-1",
    "group_id": "1-GROUP-1",
    "link_type": "AppDataStaged",
    "staging_environment": "1-ENVIRONMENT-1",
    "staging_mount_base": "/mnt/staging",
    "environment_user": "1-ENVIRONMENT_USER-1",
    "parameters": {
      "postgresPort": "5432,"
    },
    "sync_parameters": {
      "resync": true
    }
  }'

Responses

Bodyapplication/json

jobobject(Job)

An asynchronous task.

dsource_idstring

The ID of the dSource.

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"
  },
  "dsource_id": "string"
}