Datasets API

  • 0
  • 1
  • Question
  • Updated 7 months ago
Is there an API to check the existing datasets on an Engine? If the dataset that I'm looking for is not there, is there an API to create the dataset?
Photo of Shamanth Hanchate

Shamanth Hanchate

  • 210 Points 100 badge 2x thumb

Posted 7 months ago

  • 0
  • 1
Photo of Gary Hallam

Gary Hallam, Official Rep

  • 1,946 Points 1k badge 2x thumb
Hi Shamanth,
Yes there is an API for your requirements.
You can see details of the API calls using the URL: http://<DelphixIP>/api.  The available API documentation is available here: https://docs.delphix.com/docs/reference/web-service-api-guide.
You should also take a look at dxToolkit, an opensource wrapper around the Delphix REST API, which simplifies automation: https://github.com/delphix/dxtoolkit/blob/master/README.md

You can also use the command line interface to display the REST details that get passed to the engine, which will help you to develop what you need.  CLI documentation here: https://docs.delphix.com/docs/reference/command-line-interface-guide/command-line-interface-overview  

To use the CLI simply ssh to your engine: ssh delphix_admin@<delphix_ip>
in the command line type setopt trace=true
type database
type ls
That should display the REST command for displaying all the datasets.

I hope that helps.
Regards,
Gary