Delphix API Reference URLs
Developer's Guide / Web Services 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:

Command Line Interface Guide

RESTFul APIs

Must be logged in

Users must be successfully logged in before /api pages can be accessed.

Delphix Documentation:

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 refer to the Masking documentation at https://maskingdocs.delphix.com for information on the Masking APIs.

Cookbook Examples

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

API Cookbook: Common Tasks, Workflows, and Examples

There are also working examples provided within this document and available for download as well.