Skip to content
/
Get Toolkit by ID.

Get Toolkit by ID.

Request

Security
ApiKeyAuth
Path
toolkitIdstring, non-emptyrequired

The ID of the toolkit.

curl -i -X GET \
  'https://help-api.delphix.com/_mock/data-control-tower/continuous-data/23.0.0/continuous-data-apis-dct-23.0.0/toolkits/{toolkitId}' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

OK

Bodyapplication/json
idstring

Id of the toolkit.

typestring

Specifies whether this object is toolkit or plugin

referencestring

The object reference.

engine_namestring

Name of the engine.

engine_idstring

Id of the engine.

virtual_source_definitionobject

Definition of how to provision virtual sources of this type

linked_source_definitionobject

Definition of how to link sources of this type.

discovery_definitionobject

Definition of how to discover sources of this type.

upgrade_definitionobject

Definition of how to upgrade sources of this type.

snapshot_parameters_definitionobject

The schema that defines the structure of the fields in AppDataSyncParameters.

tagsArray of objects(Tag)

Tags associated to this toolkit.

Response
{
  "id": "string",
  "type": "string",
  "reference": "string",
  "engine_name": "string",
  "engine_id": "string",
  "virtual_source_definition": {},
  "linked_source_definition": {},
  "discovery_definition": {},
  "upgrade_definition": {},
  "snapshot_parameters_definition": {},
  "tags": [
    { … }
  ]
}