There are a number of sources available to provide details, examples, and techniques for working with Delphix APIs. This section contains a small list of URLs that are worth reviewing/reading as required.

CLI (Command Line Interface)

Delphix Documentation:


Delphix Documentation:

API Documentation is also included within the Delphix Engine using the following formula:


For Example:

For a complete list of Delphix APIs - JSON schema format, use the following URL:


So, looking at the first JSON key/name:

"/delphix-about.json": {
    "cliVisibility": [
    "description": "Retrieve static system-wide properties.", 
    . . . 

And after logging into the Delphix Engine, translating this into the URL API for about;

_http:// will respond with the returned JSON data string. 

{"type":"OKResult","status":"OK","result":{"type":"PublicSystemInfo","productType":"standard","productName":"Delphix Engine","buildTitle":"Delphix Engine","buildTimestamp":"2016-09-02T22:28:43.000Z","buildVersion":{"type":"VersionInfo","major":5,"minor":1,"micro":2,"patch":0},"configured":true,"enabledFeatures":["XPP","JETSTREAM"],"apiVersion":{"type":"APIVersion","major":1,"minor":8,"micro":0},"banner":null,"locales":["en-US"],"currentLocale":"en-US"},"job":null,"action":null} 
For now, just remember that the Delphix Engine contains the API Documentation and Delphix JSON schema.

Masking APIs

Please note:

The Masking APIs are currently being overhauled to provide a complete and robust set of APIs. If you do not see the APIs you need in order to perform a certain function, contact Delphix support personnel; there may already be some internal solution that has not yet been certified for general acceptance releases. 

Cookbook Examples

Delphix documentation also includes a number of cookbook examples that will not be duplicated in this document, but may be referenced.

There are also working examples provided within this document and available for download as well. See Appendix for a complete list.