Delphix API Reference URLs
Reference / Web Service API Guide / So You Want to Work with Delphix APIs? / Delphix API Reference URLs

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:

https://docs.delphix.com/display/DOCS/Command+Line+Interface+Guide

RESTFul APIs

Delphix Documentation:

https://docs.delphix.com/display/DOCS/Web+Service+API+Guide

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

http://<delphix_engine>/api/

For Example: http://172.16.160.195/api/


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

http://<delphix_engine>/api/json/delphix.json

So, looking at the first JSON key/name:

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


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

_http://172.16.160.195/resources/json/delphix/about_ will respond with the returned JSON data string. 

{"type":"OKResult","status":"OK","result":{"type":"PublicSystemInfo","productType":"standard","productName":"Delphix Engine","buildTitle":"Delphix Engine 5.1.2.0","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. 


https://docs.delphix.com/display/DOCS/Masking+API+Calls+to+Run+a+Masking+Job 

Cookbook Examples

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

https://docs.delphix.com/display/DOCS/API+Cookbook%3A+Common+Tasks%2C+Workflows%2C+and+Examples

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