Skip to content

List all dSources.

Request

Security
ApiKeyAuth
Query
limitinteger, [ 1 .. 1000 ]

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

Default:100
Example:limit=50
cursorstring, [ 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.

sortstring or null

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

Enum:"id""-id""content_type""-content_type""database_type""-database_type""name""-name""database_version""-database_version"
Example:sort=id
permissionstring(PermissionEnum)

Restrict the objects, which are allowed.

Enum:"READ""UPDATE""DELETE""EXECUTE""CANCEL""MIGRATE""REFRESH""DISABLE""ENABLE""ABANDON"
Example:permission=READ
curl -i -X GET \
  'https://help-api.delphix.com/_mock/data-control-tower/continuous-data/22.0.0/continuous-data-apis-dct-22.0.0/dsources?limit=50&cursor=string&sort=id&permission=READ' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

OK

Bodyapplication/json
itemsArray of objects(DSource)
Example:
[ { "id": "dsource-123", "database_type": "Oracle", "name": "prod01-main", "database_version": "10.2.0.5.0", "data_uuid": "1734315df891991101eb96963535afa0", "storage_size": 339292672, "plugin_version": "1.0", "creation_date": "2021-05-01T08:51:34.148Z", "group_name": "DSources", "enabled": true, "is_detached": false, "engine_id": "engine-123", "source_id": "source-123", "status": "RUNNING", "engine_name": "engine-123-name", "cdb_id": "cdb-123", "is_appdata": true, "tags": [ … ], "primary_object_id": "1-CONTAINER-1", "primary_engine_id": "1", "primary_engine_name": "source-engine", "replicas": [ … ], "hooks": { … }, "sync_policy_id": "1-POLICY_SNAPSHOT-1", "retention_policy_id": "1-POLICY_RETENTION-1", "replica_retention_policy_id": "1-POLICY_REPLICA_RETENTION-1", "quota_policy_id": "1-POLICY_QUOTA-1", "logsync_enabled": true, "exported_data_directory": "domain0/oracle_db_container-30/oracle_timeflow-32/datafile", "template_id": "DATABASE_TEMPLATE-1" } ]
errorsArray of objects(Errors)

Sadly, sometimes requests to the API are not successful. Failures can occur for a wide range of reasons. The Errors object contains information about full or partial failures which might have occurred during the request.

response_metadataobject(PaginatedResponseMetadata)
Response
{ "items": [ { … } ], "errors": [ { … } ], "response_metadata": { "prev_cursor": "string", "next_cursor": "string", "total": 0 } }