Delphix API toolkit
What is it?
DxAPIkit are basic API scripts, which are provided by Delphix personnel. DxAPIkit scripts constist of Mac/Unix/Linux shell scripts and Windows PowerShell scripts. Functionality covers Virtualization, SelfService, Delphix Reporting and Masking scripts.
The Windows PowerShell scripts utilize the native JSON parser, ConvertFrom-Json and ConvertTo-Json, commandlet modules after PowerShell version 3 (or provided functions for version 2.x) while the Mac/Unix/Linux shell scripts require the jq command line JSON parser.
All shell scripts and some programming language examples require the curl command line library.
The scripts are provided as shell scripts and can be easily ported to your favorite programming language of choice if desirable. Various programming languages starter examples are included in the language_examples directory.
Knowledge of the Delphix functionality is required with limited programming experience recommended to use the DxAPIkit.
The goal for this project is to help Delphix users get up to speed quickly on how to use the Delphix API's.
Please check a change log for list of changes.
How to get started
Check Delphix documentation for more details
Command Line Interface Guide
Web Service API Guide
So you want to work with the Delphix APIs?
Please see each folders respective README file for details
Delphix Engine Versions Tested
curl is command line tool and library for transferring data with URLs
- NOTE: The curl command library is included with most operating systems
- Versions Tested: curl 7.19.7, 7.43.0, 7.56.1, 7.60.0
jq is a lightweight and flexible command-line JSON processor
- Required for Mac/Unix/Linux Platforms ONLY
- References: https://stedolan.github.io/jq/
- Versions Tested: jq version 1.3, 1.4
Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at
Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.
Other Projects of Interest
dxtoolkit Great Perl Library of Programs that use the Delphix APIs https://github.com/delphix/dxtoolkit
delphixpy and delphixpy-examples Delphix Python Module and great set of Example Python Programs using delphixpy module.
What is RESTFul? API? JSON? CLI? Object Reference? GET/POST? Cookies? HTTP/HTTPS? cURL? Where do I begin? Who can help me? Documentation? Tutorials? That’s great for Linux, but I am on Windows? Parse? Don’t have a clue about sed, awk, grep, cut, and other acronyms. What about Regular Expressions, like “Hello”?
Just a small sampling of questions that you may or may not know the answers to, let alone learning Delphix and a programming language. Delphix is a technical product, and being new to the Delphix family can be a bit overwhelming. The goal for the referenced document is simple, to enable users to get up to speed quickly on how to use Delphix APIs.
Hope you find it useful!