Developer resources and integrations

Introduction

Data Control Tower (DCT) provides streamlined integration layers for other products in the Delphix ecosystem, whether managing a single engine or many globally distributed engines. DCT centralizes control and orchestration so you can integrate Delphix operations into custom scripts and automation toolchains in a consistent, scalable way. This is supported through API and CLI commands.

In addition to its API and CLI interfaces, DCT also supports integrations with popular DevOps toolchains like Jenkins, ServiceNow, Terraform, and more.

For the current list of supported integrations and implementation details, visit the Delphix Ecosystem Hub documentation.

API summary

This section covers the various data APIs supported by DCT, based on common DevOps preferences described below:

REST API

The most popular option for interacting with DCT APIs. REST APIs are the foundation for all other integrations.

  • API references

    For a full, detailed view of DCT's Continuous Data and Continuous Compliance API endpoints can be found in the API references.

  • Interactive API documentation

    You can explore and experiment with the REST API directly in your web browser using the Swagger interface. To access it, enter your DCT hostname (with the protocol and suffix included) followed by the /api path in the address bar. For example, if DCT is running on gateway.example.com, navigate to https://gateway.example.com/dct/api.

  • Authentication with Swagger

    When authenticating with the Swagger API, be sure to prefix your API key with apk. For instance, if your API key is 1.2345, you should use apk 1.2345 as the authentication header.

CLI and dct-toolkit

The second most popular option for interacting with DCT APIs, done through a command line called the dct-toolkit. See the DCT Toolkit documentation (and further, the Command references page) for more details.

Integrations

If you prefer a more out-of-the-box approach for your DevOps tooling, Delphix offers a wide array of integration options, outlined more in the Ecosystem hub for integrations documentation. There, you can find information on Delphix-supported integrations, such as ServiceNow, Jenkins, Terraform, or Kubernetes.

Go SDK

For developers who prefer to work with Go, DCT provides a Go SDK to help simplify development and integration. See the Go Client SDK documentation for more details.

Python SDK

The Python SDK is another option for interacting with DCT, offering a Pythonic way to automate tasks within DCT. See the Python SDK documentation for more details.

  • You can install the latest version with the following command:

    Copy 
    python -m pip install delphix-dct-api

  • The following snippet exemplifies how to use the Python SDK to query DCT for information about connected Continuous Data Engines:

    Copy 
    import delphix.api.gateway
    import delphix.api.gateway.configuration
    import delphix.api.gateway.api.management_api

    cfg = delphix.api.gateway.configuration.Configuration()
    cfg.host = "<https://localhost/dct/v3>"# For example purposes
    cfg.verify_ssl = False

    # Replace the string with your own API key
    cfg.api_key['ApiKeyAuth'] = 'apk 3.tEd4DXFce'

    api_client = delphix.api.gateway.ApiClient(configuration=cfg)
    engines_api = delphix.api.gateway.api.management_api.ManagementApi(api_client)

    print(engines_api.get_registered_engines())

  • The result should appear similar to the following:

    Copy 
    {
        "items": [
            {
                "connection_status": "ONLINE",
                "cpu_core_count": 2,
                "data_storage_capacity": 23404216320,
                "data_storage_used": 11589626880,
                "hostname": "avm.delphix.com",
                "id": 1,
                "insecure_ssl": True,
                "memory_size": 8589934592,
                "name": "vmname",
                "password": "******",
                "status": "CREATED",
                "tags": [],
                "type": "UNSET",
                "unsafe_ssl_hostname_check": False,
                "username": "admin",
                "uuid": "ec2fbfea-928b-07f8-94c4-29fea614624f",
                "version": "6.1.0.0"        }
        ]
    }